Base64ToString (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 8: Line 8:
<td>A string variable to receive the unencoded value of the method object <var class="term">string</var>.</td></tr>
<td>A string variable to receive the unencoded value of the method object <var class="term">string</var>.</td></tr>
<tr><th>string</th>
<tr><th>string</th>
<td>The input, Base64-encoded string value.</td></tr>
<td>The input, base64-encoded string value.</td></tr>
</table>
</table>


Line 19: Line 19:


==Usage notes==
==Usage notes==
<ul><li>Base-64 encoding is useful for encoding strings that might contain binary or other characters that could cause problems in certain contexts. For example, binary characters can be problematic when sent in e-mail.<li>Base-64 encoding is an alternative to hexadecimal encoding. Hexadecimal encoding has the advantage that it's simpler, but it has the disadvantage that it requires two bytes for every encoded byte. Base-64 encoding, because it uses more characters (64, as the name would suggest), only requires four bytes for every three encoded bytes.
<ul><li>Base64 encoding is useful for encoding strings that might contain binary or other characters that could cause problems in certain contexts. For example, binary characters can be problematic when sent in e-mail.<li>Base64 encoding is an alternative to hexadecimal encoding. Hexadecimal encoding has the advantage that it's simpler, but it has the disadvantage that it requires two bytes for every encoded byte. Base64 encoding, because it uses more characters (64, as the name would suggest), only requires four bytes for every three encoded bytes.
<li>A complete explanation of base-64 encoding can be easily found on the internet or in many software textbooks.
<li>A complete explanation of base64 encoding can be easily found on the internet or in many software textbooks.
<li>The <var>Base64ToString</var> function accepts both the standard base64 encoding (where the encoded string is padded out to an even multiple of four bytes by adding trailing equal signs) and a non-standard encoding (where no trailing equal signs are added and the encoded string might not be an exact multiple of four bytes).
<li>The <var>Base64ToString</var> function accepts both the standard base64 encoding (where the encoded string is padded out to an even multiple of four bytes by adding trailing equal signs) and a non-standard encoding (where no trailing equal signs are added and the encoded string might not be an exact multiple of four bytes).
<li><var>Base64ToString</var> is available as of <var class="product">[[Sirius Mods|Sirius Mods]]</var> version 7.2.
<li><var>Base64ToString</var> is available as of <var class="product">[[Sirius Mods|Sirius Mods]]</var> version 7.2.

Revision as of 20:25, 12 April 2012

Convert a base 64 string to Ebcdic (String class)


Syntax

%outString = string:Base64ToString Throws InvalidBase64Data

Syntax terms

%outString A string variable to receive the unencoded value of the method object string.
string The input, base64-encoded string value.

Exceptions

Base64ToString can throw the following exceptions:

InvalidBase64data
If the method object string does not contain a properly encoded base64 value. The exception object indicates the position of the first invalid character in the method object string.

Usage notes

  • Base64 encoding is useful for encoding strings that might contain binary or other characters that could cause problems in certain contexts. For example, binary characters can be problematic when sent in e-mail.
  • Base64 encoding is an alternative to hexadecimal encoding. Hexadecimal encoding has the advantage that it's simpler, but it has the disadvantage that it requires two bytes for every encoded byte. Base64 encoding, because it uses more characters (64, as the name would suggest), only requires four bytes for every three encoded bytes.
  • A complete explanation of base64 encoding can be easily found on the internet or in many software textbooks.
  • The Base64ToString function accepts both the standard base64 encoding (where the encoded string is padded out to an even multiple of four bytes by adding trailing equal signs) and a non-standard encoding (where no trailing equal signs are added and the encoded string might not be an exact multiple of four bytes).
  • Base64ToString is available as of Sirius Mods version 7.2.

Examples

The following statement displays Sleeping Bear:

printText {'4pOFhZeJlYdAwoWBmQ==':base64toString}

See also