$Lstr Base64 Decode: 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 from base 64 to byte string<section end="desc" /></span>
<span class="pageSubtitle"><section begin="desc" />Convert from base 64 to byte string<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_Decode 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_Decode function is the [[Base64ToString (String function)]].</p>


 
This function converts from a base 64 encoded string to the decoded byte string. It is identical to [[$Base64_Decode]], except it is longstring capable.  
 
This function converts from a base 64 encoded string to the decoded byte string. It is identical to $Base64_Decode (:hdref refid=b64dec.), except it is longstring capable.  


The $Lstr_Base64_Decode function accepts one argument and returns a string result whose base 64 encoding is that argument.  
The $Lstr_Base64_Decode function accepts one argument and returns a string result whose base 64 encoding is that argument.  
Line 13: Line 11:


The returned value is the base 64 decoding of the argument string. If the argument is not a valid base 64 encoding, the null string is returned.
The returned value is the base 64 decoding of the argument string. If the argument is not a valid base 64 encoding, the null string is returned.
==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /> %DECODED = $Lstr_Base64_Decode(string)
<p class="syntax"><section begin="syntax" /> %DECODED = $Lstr_Base64_Decode(string)
Line 20: Line 19:
<p class="caption">%DECODED is set to the base 64 decoding of :hp1.string:ehp1..</p>
<p class="caption">%DECODED is set to the base 64 decoding of :hp1.string:ehp1..</p>


For example, given the following argument of length 4:


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


You can check for an invalid base 64 encoding by checking for the null string return value from $Lstr_Base64_Decode. Of course, if it is possible that the argument is null, the null string is a valid returned value. If you need to check for errors, and the null string is a possible argument value, you can use an approach such as the following:
You can check for an invalid base 64 encoding by checking for the null string return value from $Lstr_Base64_Decode. Of course, if it is possible that the argument is null, the null string is a valid returned value. If you need to check for errors, and the null string is a possible argument value, you can use an approach such as the following:
<p class="code"> %STR = $Lstr_Base64_Decode(%IN)
<p class="code"> %STR = $Lstr_Base64_Decode(%IN)
  IF %STR EQ ''
  IF %STR EQ ''
IF %IN NE '' THEN
    IF %IN NE '' THEN
error code ...
      error code ...
END IF
    END IF
  END IF
  END IF
</p>
</p>




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


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:23, 10 February 2011

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

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

This function converts from a base 64 encoded string to the decoded byte string. It is identical to $Base64_Decode, except it is longstring capable.

The $Lstr_Base64_Decode function accepts one argument and returns a string result whose base 64 encoding is that argument.

The first argument is a longstring which is a base 64 encoding.

The returned value is the base 64 decoding of the argument string. If the argument is not a valid base 64 encoding, the null string is returned.

Syntax

<section begin="syntax" /> %DECODED = $Lstr_Base64_Decode(string) <section end="syntax" />

$Lstr_Base64_Decode Function

%DECODED is set to the base 64 decoding of :hp1.string:ehp1..

For example, given the following argument of length 4:

%JUNK = $Lstr_Base64_Decode('ABCD')

%JUNK is set to the byte string (of length 3) represented in hexadecimal as X'001083'.

You can check for an invalid base 64 encoding by checking for the null string return value from $Lstr_Base64_Decode. Of course, if it is possible that the argument is null, the null string is a valid returned value. If you need to check for errors, and the null string is a possible argument value, you can use an approach such as the following:

%STR = $Lstr_Base64_Decode(%IN) IF %STR EQ IF %IN NE THEN error code ... END IF END IF


$Lstr_Base64_Encode is the inverse of $Lstr_Base64_Decode.

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

Products authorizing $Lstr_Base64_Decode

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$Lstr_Base64_Decode&oldid=34847"