HexToInteger (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (re-match syntax diagram to revised template; fix tags. Still some link targets that need to be found / written.)
Line 16: Line 16:


==Usage Notes==
==Usage Notes==
<ul><li><var>HexToInteger</var> is available as of version 7.5 of the <var class=product>Sirius Mods</var>.</ul>
<ul><li><var>HexToInteger</var> is available as of <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> version 7.5.</ul>


==See also==
==See also==
{{Template:String:HexToInteger footer}}
{{Template:String:HexToInteger footer}}

Revision as of 11:37, 22 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

See also