$X2D: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 4: | Line 4: | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $X2D function is the [[HexToInteger (String function)]] or the [[HexToString (String function)]]. For a full list of string and numeric conversion functions see [[List of String methods]] and [[List of Float methods]].</p> | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $X2D function is the [[HexToInteger (String function)]] or the [[HexToString (String function)]]. For a full list of string and numeric conversion functions see [[List of String methods]] and [[List of Float methods]].</p> | ||
The $X2D function returns the integer | The <var>$X2D</var> function returns the integer that is represented by the hexadecimal input string. | ||
$X2D | ==Syntax== | ||
<p class="syntax">%value = $X2D([hex_string], [width]) | |||
</p> | |||
The leading bit of the hexadecimal string is repeated out to the length derived from the | ===Syntax terms=== | ||
<table> | |||
<tr><th>%value</th> | |||
<td>The integer value that is represented by the <var class="term">hex_string</var> hexadecimal string. | |||
<p> | |||
The leading bit of the hexadecimal string is repeated out to the length derived from the <var class="term">width</var> argument. If the length is less than the length of the hexadecimal string, the leftmost digits of the hexadecimal string are dropped. The hexadecimal string represents an integer using 2's complement. </p></td></tr> | |||
<tr><th>hex_string</th> | |||
< | <td>The hex string to be converted to an integer. If it is omitted, or is the null string, or contains characters other than '0' through '9', 'A' through 'F', or 'a' through 'f', <var class="term">%value</var> is zero. </td></tr> | ||
</ | |||
< | <tr><th>width</th> | ||
<td>The number of characters to use from <var class="term">hex_string</var>. If <var class="term">width</var> is omitted or is greater than 8, 8 characters are used. If, after conversion to an integer, it is 0 or less, or can't be represented as a 31 bit value, the result of <var>$X2D</var> is zero. </td></tr> | |||
</table> | |||
==Example== | ==Example== | ||
The following | The following request will print the value <code>-1</code>: | ||
<p class="code">B | <p class="code">B | ||
Print $x2d('0F', 1) | |||
End | |||
</p> | </p> | ||
Revision as of 20:14, 10 April 2013
Convert hex string to integer
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $X2D function is the HexToInteger (String function) or the HexToString (String function). For a full list of string and numeric conversion functions see List of String methods and List of Float methods.
The $X2D function returns the integer that is represented by the hexadecimal input string.
Syntax
%value = $X2D([hex_string], [width])
Syntax terms
| %value | The integer value that is represented by the hex_string hexadecimal string.
The leading bit of the hexadecimal string is repeated out to the length derived from the width argument. If the length is less than the length of the hexadecimal string, the leftmost digits of the hexadecimal string are dropped. The hexadecimal string represents an integer using 2's complement. |
|---|---|
| hex_string | The hex string to be converted to an integer. If it is omitted, or is the null string, or contains characters other than '0' through '9', 'A' through 'F', or 'a' through 'f', %value is zero. |
| width | The number of characters to use from hex_string. If width is omitted or is greater than 8, 8 characters are used. If, after conversion to an integer, it is 0 or less, or can't be represented as a 31 bit value, the result of $X2D is zero. |
Example
The following request will print the value -1:
B Print $x2d('0F', 1) End