X (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 13: Line 13:
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%out                                                                                             </th>
<tr><th>%out</th>
<td>A string variable to receive the unencoded value of the method object string.                    </td></tr>
<td>A string variable to receive the unencoded value of the method object string.                    </td></tr>
<tr><th>string                                                                                           </th>
<tr><th>string</th>
<td>A hex-encoded string value.</td></tr>
<td>A hex-encoded string value.</td></tr>
</table>
</table>

Revision as of 15:48, 19 January 2011

Hex constant method (String class)


This intrinsic function returns the unencoded value of a hex-encoded string. It is a compile-time-only equivalent of the HexToString method. Since in use the method acts like a hex constant, it is also documented with the Constant methods.

The X function treats each input character as an input hex digit.

The X method is available as of Sirius Mods version 7.3.

Syntax

%outString = string:X

Syntax terms

%out A string variable to receive the unencoded value of the method object string.
string A hex-encoded string value.

Usage notes

  • As in all Janus SOAP system methods with string outputs, the %out string variable provides longstring behavior. This adds 28 bytes of VTBL usage to every X constant, however.
  • Although its utility is dubious, the following is valid and sets %x to 'X'01:
   %x = 'f0f1':x:x
  • The X function requires a method object string with an even number of bytes.

Example

The following statement would display '1234':

   printText {'f1f2f3f4':x}

See also

List of intrinsic String methods