HexToInteger (String function): Difference between revisions

From m204wiki
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. Still some link targets that need to be found / written.)
Line 9: Line 9:
<tr><th>%number</th>
<tr><th>%number</th>
<td>A numeric variable to receive the integer value of the method object <var class="term">string</var>.</td></tr>
<td>A numeric variable to receive the integer value of the method object <var class="term">string</var>.</td></tr>
<tr><th><var class="term">string</var></th>
<tr><th>string</th>
<td>A hex-encoded string value that contains an even number of characters.</td></tr>
<td>A hex-encoded string value that contains an even number of characters.</td></tr>
<tr><th>Signed</th>
<tr><th>Signed</th>
<td>This is an optional, but <var>[[Methods#Named parameters|NameRequired]]</var>, argument and is a <var>[[boolean enumeration]]</var>; if you specify a value, the parameter name <var class="term">Signed</var> is required.<p><var class="term">Signed</var> is a <var>[[boolean enumeration]]</var> value that indicates whether the method object string is converted to a signed integer.<ul><li><var class="term">Signed</var> is an optional argument that defaults to <code>False</code>, which produces an unsigned conversion.<li>If <code>Signed=True</code>, the method object <var class="term">string</var> is treated as if it were preceded by a negative sign, a two's complement conversion is performed, and the returned value is preceded by a negative sign.</ul></p></td></tr>
<td>This is an optional, but <var>[[Methods#Named parameters|NameRequired]]</var>, argument and is a <var>[[boolean enumeration]]</var> value that indicates whether the method object string is converted to a signed integer.<ul><li><var class="term">Signed</var> defaults to <code>False</code>, which produces an unsigned conversion.<li>If <code>Signed=True</code>, the method object <var class="term">string</var> is treated as if it were preceded by a negative sign, a two's complement conversion is performed, and the returned value is preceded by a negative sign.</ul></td></tr>
</table>
</table>



Revision as of 03:00, 2 February 2011

Convert a hexadecimal string to an integer (String class)

[Introduced in Sirius Mods 7.5]


HexToInteger is an intrinsic function that returns the integer value of a hex-encoded string.

Syntax

%number = string:HexToInteger[( [Signed= boolean])] Throws InvalidHexData

Syntax terms

%number A numeric variable to receive the integer value of the method object string.
string A hex-encoded string value that contains an even number of characters.
Signed This is an optional, but NameRequired, argument and is a boolean enumeration value that indicates whether the method object string is converted to a signed integer.
  • Signed defaults to False, which produces an unsigned conversion.
  • If Signed=True, the method object string is treated as if it were preceded by a negative sign, a two's complement conversion is performed, and the returned value is preceded by a negative sign.

Usage Notes

  • HexToInteger is available as of version 7.5 of the Sirius Mods.

See also