IntegerToHex (Float function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (→Usage notes) |
||
| (25 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Float:IntegerToHex subtitle}} | {{Template:Float:IntegerToHex subtitle}} | ||
The <var>IntegerToHex</var> [[Intrinsic classes|intrinsic]] function converts an integer to its hexadecimal string representation. Only integers that convert to four hex bytes or less (so a maximum output string length of eight) are allowed. | |||
Only integers that convert to four hex bytes or less | |||
(so a maximum output string length of eight) are allowed. | |||
==Syntax== | ==Syntax== | ||
{{Template:Float:IntegerToHex syntax}} | {{Template:Float:IntegerToHex syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%string</th> | ||
<td>A string variable to receive the converted value of the method object | <td>A string variable to receive the converted value of the method object: <var class="term">float</var>. </td></tr> | ||
<tr><th> | |||
<td>An integer value. The number must be convertible to a hex string that does not exceed the output size specified by the | <tr><th>float</th> | ||
<td>An integer value. The number must be convertible to a hex string that does not exceed the output size specified by the <var class="term">number</var> value (plus a sign bit, if that is indicated). | |||
<tr><th> | <p>If <var class="term">number</var> is a negative value, you must specify <code>Signed=true</code>. </p></td></tr> | ||
<td>A non-zero numeric value that specifies the number of | |||
<tr><th>Signed | <tr><th>number</th> | ||
<td>This name | <td>A non-zero numeric value that specifies the number of bytes to be returned in hexadecimal format (two characters for each byte). The value must not be greater than 4.</td></tr> | ||
<tr><th><var>Signed</var></th> | |||
<td>This is an optional, [[Notation conventions for methods#Named parameters|name required]], <var>Boolean</var> value that indicates whether the method object number is to be converted to signed output or not. If <code>Signed=True</code>, the resulting hex string will begin with a sign bit '<code>00</code>' or '<code>FF</code>'), and a two's complement conversion is performed. | |||
<p> | |||
<var>Signed</var> defaults to <var>False</var>, which produces an unsigned conversion.</p></td></tr> | |||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | |||
<li>If the specified size of the returned hex value is greater than the hex value, the returned value is padded on the left with repetitions of the appropriate sign bit. | |||
<li>If the specified size of the returned hex value is insufficient to contain the converted value and any necessary sign bit, the request is cancelled. | |||
<li><var>IntegerToHex</var> is available as of <var class="product">Sirius Mods</var> Version 7.5. | |||
</ul> | |||
==Examples== | ==Examples== | ||
The following statement displays | <ol> | ||
<li>The following statement displays <code>00000000</code>: | |||
<p class="code">[[PrintText statement|printText]] {0:integerToHex(4)} | |||
</p> | |||
= | <li>The following statement displays <code>0000000A</code>: | ||
<p class="code">printText {10:integerToHex(4)} | |||
</p> | |||
<li>The following statement displays <code>FF</code>: | |||
<p class="code">printText {255:integerToHex(1)} | |||
</p> | |||
<li>The following statement displays <code>FF</code>: | |||
<p class="code">printText {-1:integerToHex(1, signed=true)} | |||
</p> | |||
</ol> | |||
==See also== | |||
<ul> | |||
<li>The inverse of the <var>IntegerToHex</var> method is <var>[[HexToInteger (String function)|HexToInteger]]</var>. | |||
</ul> | |||
{{Template:Float:IntegerToHex footer}} | |||
Latest revision as of 17:52, 2 November 2012
Convert an integer to a hexadecimal string (Float class)
The IntegerToHex intrinsic function converts an integer to its hexadecimal string representation. Only integers that convert to four hex bytes or less (so a maximum output string length of eight) are allowed.
Syntax
%string = float:IntegerToHex( number, [Signed= boolean])
Syntax terms
| %string | A string variable to receive the converted value of the method object: float. |
|---|---|
| float | An integer value. The number must be convertible to a hex string that does not exceed the output size specified by the number value (plus a sign bit, if that is indicated).
If number is a negative value, you must specify |
| number | A non-zero numeric value that specifies the number of bytes to be returned in hexadecimal format (two characters for each byte). The value must not be greater than 4. |
| Signed | This is an optional, name required, Boolean value that indicates whether the method object number is to be converted to signed output or not. If Signed=True, the resulting hex string will begin with a sign bit '00' or 'FF'), and a two's complement conversion is performed.
Signed defaults to False, which produces an unsigned conversion. |
Usage notes
- If the specified size of the returned hex value is greater than the hex value, the returned value is padded on the left with repetitions of the appropriate sign bit.
- If the specified size of the returned hex value is insufficient to contain the converted value and any necessary sign bit, the request is cancelled.
- IntegerToHex is available as of Sirius Mods Version 7.5.
Examples
- The following statement displays
00000000:printText {0:integerToHex(4)}
- The following statement displays
0000000A:printText {10:integerToHex(4)}
- The following statement displays
FF:printText {255:integerToHex(1)}
- The following statement displays
FF:printText {-1:integerToHex(1, signed=true)}
See also
- The inverse of the IntegerToHex method is HexToInteger.