HexToInteger (String function)

From m204wiki
Revision as of 21:25, 3 September 2015 by ELowell (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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.
  • 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.

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.

See also