$Lstr Base64 Encode: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
mNo edit summary
Line 2: Line 2:
<span class="pageSubtitle"><section begin="desc" />Convert byte string to base 64<section end="desc" /></span>
<span class="pageSubtitle"><section begin="desc" />Convert byte string to base 64<section end="desc" /></span>


<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Base64_Encode function is [[to be entered]].</p>
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Base64_Encode function is the [[StringToBase64 (String function)]].</p>


 
This function converts a byte string into its base 64 encoding. It is identical to [[$Base64_Encode]], except it is longstring capable.  
 
This function converts a byte string into its base 64 encoding. It is identical to $Base64_Encode (:hdref refid=b64enc.), except it is longstring capable.  


The $Lstr_Base64_Encode function accepts one argument and returns a string result which is the base 64 encoding of that argument.  
The $Lstr_Base64_Encode function accepts one argument and returns a string result which is the base 64 encoding of that argument.  
Line 13: Line 11:


The returned value is the base 64 encoding of the argument string.
The returned value is the base 64 encoding of the argument string.
==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /> %CODED = $Lstr_Base64_Encode(string)
<p class="syntax"><section begin="syntax" /> %CODED = $Lstr_Base64_Encode(string)
Line 18: Line 17:
<p class="caption">$Lstr_Base64_Encode Function
<p class="caption">$Lstr_Base64_Encode Function
</p>
</p>
<p class="caption">%CODED is set to the base 64 encoding of :hp1.string:ehp1..</p>
<p class="caption">%CODED is set to the base 64 encoding of ''string''</p>


For example, given the following argument of length 3:


For example, given the following argument of length 3:
<p class="code"> %JUNK = $Lstr_Base64_Encode($X2C('001083'))
<p class="code"> %JUNK = $Lstr_Base64_Encode($X2C('001083'))
</p>
</p>
%JUNK is set to the byte string (of length 4) represented in character as 'ABCD'.  
%JUNK is set to the byte string (of length 4) represented in character as 'ABCD'.  


$Lstr_Base64_Decode (:hdref refid=b64decl.) is the inverse of $Lstr_Base64_Encode.  
[[$Lstr_Base64_Decode]] is the inverse of $Lstr_Base64_Encode.  


This $function is new in Version 6.8 of the ''[[Sirius Mods]]''.<p>
This $function is new in Version 6.8 of the ''[[Sirius Mods]]''.<p>

Revision as of 21:25, 10 February 2011

<section begin="desc" />Convert byte string to base 64<section end="desc" />

Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Base64_Encode function is the StringToBase64 (String function).

This function converts a byte string into its base 64 encoding. It is identical to $Base64_Encode, except it is longstring capable.

The $Lstr_Base64_Encode function accepts one argument and returns a string result which is the base 64 encoding of that argument.

The first argument is a longstring.

The returned value is the base 64 encoding of the argument string.

Syntax

<section begin="syntax" /> %CODED = $Lstr_Base64_Encode(string) <section end="syntax" />

$Lstr_Base64_Encode Function

%CODED is set to the base 64 encoding of string

For example, given the following argument of length 3:

%JUNK = $Lstr_Base64_Encode($X2C('001083'))

%JUNK is set to the byte string (of length 4) represented in character as 'ABCD'.

$Lstr_Base64_Decode is the inverse of $Lstr_Base64_Encode.

This $function is new in Version 6.8 of the Sirius Mods.

Products authorizing $Lstr_Base64_Encode