$Lstr Base64 Encode: Difference between revisions
(Automatically generated page update) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Convert byte string to base 64</span> | <span class="pageSubtitle">Convert byte string to base 64</span> | ||
<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Base64_Encode function is | <p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Base64_Encode function is <var>[[StringToBase64 (String function)|StringToBase64]]</var>.</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]], except it is longstring capable. | ||
| Line 13: | Line 13: | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><span class="term">% | <p class="syntax"><span class="term">%coded</span> = <span class="literal">$Lstr_Base64_Encode</span>(<span class="term">string</span>) | ||
</p> | </p> | ||
<p>% | <p>%coded is set to the base 64 encoding of ''string''</p> | ||
==Usage notes== | ==Usage notes== | ||
[[$Lstr_Base64_Decode]] is the inverse of $Lstr_Base64_Encode. | <ul> | ||
<li>[[$Lstr_Base64_Decode]] is the inverse of $Lstr_Base64_Encode. | |||
This $function is new in Version 6.8 of the <var class="product">[[Sirius Mods]]</var>. | <li>This $function is new in Version 6.8 of the <var class="product">[[Sirius Mods]]</var>. | ||
</ul> | |||
==Example== | ==Example== | ||
Given the following argument of length 3: | Given the following argument of length 3: | ||
<p class="code"> % | <p class="code">%junk = $Lstr_Base64_Encode($X2C('001083')) | ||
</p> | </p> | ||
% | <var class="term">%junk</var> is set to the byte string (of length 4) represented in character as 'ABCD'. | ||
==Products authorizing {{PAGENAMEE}}== | ==Products authorizing {{PAGENAMEE}}== | ||
| Line 42: | Line 43: | ||
<li>[[Japanese functions]]</li> | <li>[[Japanese functions]]</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$Lstr_Base64_Encode]] | [[Category:$Functions|$Lstr_Base64_Encode]] | ||
Revision as of 23:55, 18 July 2013
Convert byte string to base 64
Note: Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Base64_Encode function is StringToBase64.
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
%coded = $Lstr_Base64_Encode(string)
%coded is set to the base 64 encoding of string
Usage notes
- $Lstr_Base64_Decode is the inverse of $Lstr_Base64_Encode.
- This $function is new in Version 6.8 of the Sirius Mods.
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'.