HexToInteger (String function)

From m204wiki
Revision as of 17:46, 4 May 2011 by JALWiccan (talk | contribs) (1 revision)
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, 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 Sirius Mods version 7.5.

See also