HexToString (String function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:String:HexToString subtitle}} | |||
This [[Intrinsic classes|intrinsic]] function returns the unencoded value of a hex encoded string. | This [[Intrinsic classes|intrinsic]] function returns the unencoded value of a hex encoded string. | ||
HexToString is available as of version 7.2 of the [[Sirius Mods]]. | HexToString is available as of version 7.2 of the [[Sirius Mods]]. | ||
=== | ==Syntax== | ||
{{Template:String:HexToString syntax}} | |||
===Syntax | ===Syntax terms=== | ||
<dl> | <dl> | ||
<dt>%outStr | <dt>%outStr | ||
| Line 23: | Line 25: | ||
string had an odd number of characters. | string had an odd number of characters. | ||
</dl> | </dl> | ||
==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. | *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. | ||
*The HexToString function requires a method object string with an even number of bytes. | *The HexToString function requires a method object string with an even number of bytes. | ||
| Line 30: | Line 32: | ||
*The inverse of HexToString is [[StringToHex (String function)|StringToHex]]. | *The inverse of HexToString is [[StringToHex (String function)|StringToHex]]. | ||
==Examples== | |||
*The following statement displays ''''Saint Marie'''': | *The following statement displays ''''Saint Marie'''': | ||
[[Intrinsic classes#printtext|printText]] {'E2818995A340D481998985':hexToString} | [[Intrinsic classes#printtext|printText]] {'E2818995A340D481998985':hexToString} | ||
Revision as of 05:14, 19 January 2011
Convert a hexadecimal string to Ebcdic (String class)
This intrinsic function returns the unencoded value of a hex encoded string.
HexToString is available as of version 7.2 of the Sirius Mods.
Syntax
%outString = string:HexToString Throws InvalidHexData
Syntax terms
- %outStr
- 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.
- The HexToString function requires a method object string with an even number of bytes.
- HexToString displays a question mark ('?') in a case where a converted hex value has no displayable character representation.
- The X function is a compile-time only equivalent of the HexToString method.
- The inverse of HexToString is StringToHex.
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)}