StringToBase64 (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (match syntax diagram to revised template; fix tags.)
Line 1: Line 1:
{{Template:String:StringToBase64 subtitle}}
{{Template:String:StringToBase64 subtitle}}


This [[Intrinsic classes|intrinsic]] function returns the base-64 encoded value of the method object string.
The <var>StringToBase64</var> [[Intrinsic classes|intrinsic]] function returns the base-64 encoded value of the method object string.


<var>StringToBase64</var> is available as of version 7.2 of the <var class=product>Sirius Mods</var>.
==Syntax==
==Syntax==
{{Template:String:StringToBase64 syntax}}
{{Template:String:StringToBase64 syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%outStr</th>
<tr><th>%outString</th>
<td>A string variable to receive the base-64 encoded value of the method object string.                       </td></tr>
<td>A string variable to receive the base-64 encoded value of the method object <var class="term>string</var>.</td></tr>
<tr><th>string</th>
<tr><th>string</th>
<td>The string to be base-64 encoded.</td></tr>
<td>The string to be base-64 encoded.</td></tr>
Line 15: Line 14:


==Usage notes==
==Usage notes==
*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. <br>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.
<ul><li>A complete explanation of base-64 encoding can be easily found on the Internet or in many software textbooks.
*A complete explanation of base-64 encoding can be easily found on the Internet or in many software textbooks.
<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 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 <var>StringToBase64</var> 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.
<li>The <var>StringToBase64</var> 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.
*The inverse of <var>StringToBase64</var> is [[Base64toString (String function)|Base64toString]]
<li><var>StringToBase64</var> is available as of <var class="product">[[Sirius Mods]]</var> version 7.2.</ul>


==Examples==
==Examples==
<ol><li>The following statement displays ''''8PHy8/T19vf4+Q=='''':
<p class="code">printText {'0123456789':stringTobase64}
</p></ol>


The following statement displays ''''8PHy8/T19vf4+Q=='''':
<p class="code">[[Intrinsic classes#printtext|printText]] {'0123456789':stringTobase64}
</p>
==See also==
==See also==
<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>
{{Template:String:StringToBase64 footer}}
{{Template:String:StringToBase64 footer}}

Revision as of 06:01, 2 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

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=StringToBase64_(String_function)&oldid=1642"