HexToInteger (String function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:String:HexToInteger subtitle}} | {{Template:String:HexToInteger subtitle}} | ||
<var>HexToInteger</var> is an [[Intrinsic classes|intrinsic]] function that returns the integer value of a hex-encoded string. | <var>HexToInteger</var> is an [[Intrinsic classes|intrinsic]] function that returns the integer value of a hex-encoded string. | ||
| Line 7: | Line 6: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%number</th> | |||
<tr><th nowrap>%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>string</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><var>Signed</var></th> | <tr><th><var>Signed</var></th> | ||
<td>This is an optional, | <td>This is an optional, [[Methods#Named parameters|name required]], argument that is a <var>[[Boolean enumeration]]</var> value that indicates whether the method object string is converted to a signed integer. | ||
<ul> | |||
<li><var>Signed</var> defaults to <var>False</var>, 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> | ||
| Line 24: | Line 29: | ||
string had an odd number of characters. | string had an odd number of characters. | ||
</dl> | </dl> | ||
==See also== | ==See also== | ||
{{Template:String:HexToInteger footer}} | {{Template:String:HexToInteger footer}} | ||
Latest revision as of 21:25, 3 September 2015
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, name required, argument that is a Boolean enumeration value that indicates whether the method object string is converted to a signed integer.
|
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.