BinaryToInteger (String function): Difference between revisions
Jump to navigation
Jump to search
m (printtext) |
m (printtext) |
||
Line 11: | Line 11: | ||
<tr><th>string</th> | <tr><th>string</th> | ||
<td>A binary string value. The string's length must be four characters or less, but greater than zero.</td></tr> | <td>A binary string value. The string's length must be four characters or less, but greater than zero.</td></tr> | ||
<tr><th>Signed</th> | <tr><th><var>Signed</var></th> | ||
<td>This is an optional, but <var>[[Methods#Named parameters|NameRequired]]</var>, argument is a <var>[[boolean enumeration]]</var> that indicates whether the method object <var class="term">string</var> is to be converted to a signed integer or not.<ul><li><var class="term">Signed</var> defaults to <code>False</code>, which produces an unsigned conversion.<li>If <code>Signed=True</code>, the method object <var class="term">string</var> 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.</ul></td></tr> | <td>This is an optional, but <var>[[Methods#Named parameters|NameRequired]]</var>, argument is a <var>[[boolean enumeration]]</var> that indicates whether the method object <var class="term">string</var> is to be converted to a signed integer or not.<ul><li><var class="term">Signed</var> defaults to <code>False</code>, which produces an unsigned conversion.<li>If <code>Signed=True</code>, the method object <var class="term">string</var> 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.</ul></td></tr> | ||
</table> | </table> |
Revision as of 00:21, 13 April 2011
Convert a binary string to an integer (String class)
BinaryToInteger is an intrinsic function that treats a string as if it were binary and converts it to an integer. The string may contain no more than four characters.
Syntax
%number = string:BinaryToInteger[( [Signed= boolean])]
Syntax terms
%number | A numeric variable to receive the integer value of the method object string. |
---|---|
string | A binary string value. The string's length must be four characters or less, but greater than zero. |
Signed | This is an optional, but NameRequired, argument is a boolean enumeration that indicates whether the method object string is to be converted to a signed integer or not.
|
Usage notes
- The BinaryToInteger function is available as of "Sirius Mods" version 7.3.
Examples
- The following statement displays
240
:printText {'0':binaryToInteger}
- The following statement displays
61680
:printText {'00':binaryToInteger}
- The result of the following pair of statements is
-3856
:%string = '00' printText {%string:binaryToInteger(signed=true)}
- The result of the following pair of statements is
0
:%string = '00':hexToString printText {%string:binaryToInteger}
See also
- The inverse of BinaryToInteger is IntegerToBinary.