StringToBase64 (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (match syntax diagram to revised template; fix tags.)
m (Full stop)
Line 26: Line 26:
==See also==
==See also==
<ul><li>*The inverse of <var>StringToBase64</var> is [[Base64toString (String function)|Base64toString]]
<ul><li>*The inverse of <var>StringToBase64</var> is [[Base64toString (String function)|Base64toString]]
<li>For details of the <var>printtext</var> statement, please see <var>[[Intrinsic classes#printtext|printText]]</var></ul>
<li>For details of the <var>printtext</var> statement, please see <var>[[Intrinsic classes#printtext|printText]]</var>.</ul>
{{Template:String:StringToBase64 footer}}
{{Template:String:StringToBase64 footer}}

Revision as of 23:31, 3 February 2011

Convert an Ebcdic string to base 64 (String class)


The StringToBase64 intrinsic function returns the base-64 encoded value of the method object string.

Syntax

%outString = string:StringToBase64

Syntax terms

%outString A string variable to receive the base-64 encoded value of the method object string.
string The string to be base-64 encoded.

Usage notes

  • A complete explanation of base-64 encoding can be easily found on the Internet or in many software textbooks.
  • 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.
  • Base-64 encoding is an alternative to hexadecimal encoding. Hexadecimal encoding has the advantage that it's simpler, but as 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.
  • The StringToBase64 function returns the standard base-64 encoding of a string, where the encoded string is padded out to an even multiple of four bytes by appending equal signs.
  • StringToBase64 is available as of Sirius Mods version 7.2.

Examples

  1. The following statement displays '8PHy8/T19vf4+Q==':

    printText {'0123456789':stringTobase64}

See also