HexToInteger (String function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 8: | Line 8: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%num | <tr><th>%num</th> | ||
<td>A numeric variable to receive the integer value of the method object string. </td></tr> | <td>A numeric variable to receive the integer value of the method object string. </td></tr> | ||
<tr><th>string | <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=bool | <tr><th>Signed=bool</th> | ||
<td>This name-required argument (''''Signed'''') is a [[Boolean]] value that indicates whether the method object string is converted to a signed integer. If ''''True'''', the method object 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. Signed is an optional argument that defaults to ''''False'''', which produces an unsigned conversion.</td></tr> | <td>This name-required argument (''''Signed'''') is a [[Boolean]] value that indicates whether the method object string is converted to a signed integer. If ''''True'''', the method object 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. Signed is an optional argument that defaults to ''''False'''', which produces an unsigned conversion.</td></tr> | ||
</table> | </table> | ||
Revision as of 15:48, 19 January 2011
Convert a hexadecimal string to an integer (String class)
[Introduced in Sirius Mods 7.5]
This intrinsic function returns the integer value of a hex-encoded string.
HexToInteger is available as of version 7.5 of the Sirius Mods.
Syntax
%number = string:HexToInteger[( [Signed= boolean])] Throws InvalidHexData
Syntax terms
| %num | 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=bool | This name-required argument ('Signed') is a Boolean value that indicates whether the method object string is converted to a signed integer. If 'True', the method object 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. Signed is an optional argument that defaults to 'False', which produces an unsigned conversion. |