$Lstr Base64 Encode: Difference between revisions

Revision as of 00:34, 13 April 2013

Convert byte string to base 64

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

%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'.

Products authorizing $Lstr_Base64_Encode

@@ Line 15: / Line 15: @@
 <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>
-For example, given the following argument of length 3:
+==Usage notes==
+[[$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>.
+==Example==
+Given the following argument of length 3:
 <p class="code"> %JUNK = $Lstr_Base64_Encode($X2C('001083'))
 </p>
 %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 <var class="product">[[Sirius Mods]]</var>.<p>
 ==Products authorizing {{PAGENAMEE}}==