StringToBase64 (String function): Difference between revisions
Jump to navigation
Jump to search
m (match syntax diagram to revised template; fix tags.) |
m (→See also: link repair) |
||
| (7 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:String:StringToBase64 subtitle}} | {{Template:String:StringToBase64 subtitle}} | ||
The <var>StringToBase64</var> [[Intrinsic classes|intrinsic]] function returns the | The <var>StringToBase64</var> [[Intrinsic classes|intrinsic]] function returns the base64 encoded value of the method object string. | ||
==Syntax== | ==Syntax== | ||
| Line 8: | Line 8: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%outString</th> | <tr><th>%outString</th> | ||
<td>A string variable to receive the | <td>A string variable to receive the base64 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 | <td>The string to be base64 encoded.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul><li>A complete explanation of | <ul><li>A complete explanation of base64 encoding can be easily found on the Internet or in many software textbooks. | ||
<li> | <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 as 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>The <var>StringToBase64</var> function returns the standard | <li>The <var>StringToBase64</var> function returns the standard base64 encoding of a string, where the encoded string is padded out to an even multiple of four bytes by appending equals signs. | ||
<li><var>StringToBase64</var> is available as of <var class="product"> | <li><var>StringToBase64</var> is available as of <var class="product">Janus SOAP</var> Version 7.2.</ul> | ||
==Examples== | ==Examples== | ||
The following statement displays <code>8PHy8/T19vf4+Q==</code>: | |||
<p class="code">printText {'0123456789':stringTobase64} | <p class="code">[[PrintText statement|printText]] {'0123456789':stringTobase64} | ||
</p | </p> | ||
==See also== | ==See also== | ||
<ul><li> | <ul> | ||
<li>The inverse of <var>StringToBase64</var> is [[Base64ToString (String function)|Base64ToString]] | |||
</ul> | |||
{{Template:String:StringToBase64 footer}} | {{Template:String:StringToBase64 footer}} | ||
Latest revision as of 22:29, 25 April 2018
Convert an Ebcdic string to base 64 (String class)
The StringToBase64 intrinsic function returns the base64 encoded value of the method object string.
Syntax
%outString = string:StringToBase64
Syntax terms
| %outString | A string variable to receive the base64 encoded value of the method object string. |
|---|---|
| string | The string to be base64 encoded. |
Usage notes
- A complete explanation of base64 encoding can be easily found on the Internet or in many software textbooks.
- 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 as 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.
- The StringToBase64 function returns the standard base64 encoding of a string, where the encoded string is padded out to an even multiple of four bytes by appending equals signs.
- StringToBase64 is available as of Janus SOAP Version 7.2.
Examples
The following statement displays 8PHy8/T19vf4+Q==:
printText {'0123456789':stringTobase64}
See also
- The inverse of StringToBase64 is Base64ToString