HexToString (String function): Difference between revisions
Jump to navigation
Jump to search
m (first pass, match syntax diagram to template and fix tags) |
m (re-match syntax diagram to revised template; fix tags.) |
||
| Line 7: | Line 7: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%outString</th> | ||
<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 | <tr><th>string</th> | ||
<td>A hex-encoded string value.</td></tr> | <td>A hex-encoded string value.</td></tr> | ||
</table> | </table> | ||
| Line 32: | Line 32: | ||
==Examples== | ==Examples== | ||
<ol><li>The following statement displays <code>Saint Marie</code>: | <ol><li>The following statement displays <code>Saint Marie</code>: | ||
<p class="code"> | <p class="code">printText {'E2818995A340D481998985':hexToString} | ||
</p> | </p> | ||
<li>The following statement displays <code>??</code>' because no displayable characters exist for the specified hex values: | <li>The following statement displays <code>??</code>' because no displayable characters exist for the specified hex values: | ||
| Line 41: | Line 41: | ||
==See also== | ==See also== | ||
<ul><li>[[X (String function)|X]] is a compile-time only equivalent of the <var>HexToString</var> method. | <ul><li>[[X (String function)|X]] is a compile-time only equivalent of the <var>HexToString</var> method. | ||
<li>The inverse of <var>HexToString</var> is <var>[[StringToHex (String function)|StringToHex]]</var>.</ul> | <li>The inverse of <var>HexToString</var> is <var>[[StringToHex (String function)|StringToHex]]</var>. | ||
<li>For details of the <var>printtext</var> statement, please see <var>[[Intrinsic classes#printtext|printText]]</var></ul></ul> | |||
{{Template:String:HexToString footer}} | {{Template:String:HexToString footer}} | ||
Revision as of 03:08, 2 February 2011
Convert a hexadecimal string to Ebcdic (String class)
HexToString is an intrinsic function that returns the unencoded value of a hex encoded string.
Syntax
%outString = string:HexToString Throws InvalidHexData
Syntax terms
| %outString | A string variable to receive the unencoded value of the method object string. |
|---|---|
| string | A hex-encoded string value. |
Exceptions
This intrinsic function can throw the following exceptions:
- InvalidHexData
- If the method object string does not contain a properly encoded hexadecimal value. The exception object indicates the position of the first invalid character in the method object string, or it indicates a zero if the method object string had an odd number of characters.
Usage notes
- Hex (short for hexadecimal) encoding is usually used for debugging when there is a concern that non-displayable characters (including trailing blanks) might be present in a string. By hex-encoding such a string, all non-displayable bytes are converted to displayable hexadecimal equivalents.
- HexToString requires a method object string with an even number of bytes.
- HexToString displays a question mark (
?) in cases where a converted hex value has no displayable character representation. - HexToString is available as of Sirius Mods version 7.2.
Examples
- The following statement displays
Saint Marie:printText {'E2818995A340D481998985':hexToString}
- The following statement displays
??' because no displayable characters exist for the specified hex values:printText {'FFFE':hexToString(signed=true)}
See also
- X is a compile-time only equivalent of the HexToString method.
- The inverse of HexToString is StringToHex.
- For details of the printtext statement, please see printText