BinaryToInteger (String function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 8: | Line 8: | ||
{{Template:String:BinaryToInteger syntax}} | {{Template:String:BinaryToInteger syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
< | <table class="syntaxTable"> | ||
< | <tr><th>%num </th> | ||
< | <td>A numeric variable to receive the integer value of the method object string. </td></tr> | ||
method object string. | <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> | ||
< | <tr><th>Signed=bool </th> | ||
The string's length must be four characters or less, but greater than zero. | <td>This name-required argument (''''Signed'''') is a boolean value that indicates whether the method object string is converted to a signed integer. If ''''True'''', the method object 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, Signed is an optional argument that defaults to ''''False'''', which produces an unsigned conversion.</td></tr> | ||
< | </table> | ||
< | |||
that indicates whether the method object string is converted | |||
to a signed integer. | |||
If ''''True'''', | |||
the method object 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, | |||
Signed is an optional argument that defaults to ''''False'''', which | |||
produces an unsigned conversion. | |||
</ | |||
==Usage notes== | ==Usage notes== | ||
*The inverse of the BinaryToInteger method is [[IntegerToBinary (Float function)|IntegerToBinary]]. | *The inverse of the BinaryToInteger method is [[IntegerToBinary (Float function)|IntegerToBinary]]. | ||
Revision as of 05:39, 19 January 2011
Convert a binary string to an integer (String class)
This intrinsic function treats a string as if it were binary and converts it to an integer.
The string may contain no more than four characters.
The BinaryToInteger function is available as of version 7.3 of the Sirius Mods.
Syntax
%number = string:BinaryToInteger[( [Signed= boolean])]
Syntax terms
| %num | 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=bool | This name-required argument ('Signed') is a boolean value that indicates whether the method object string is converted to a signed integer. If 'True', the method object 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, Signed is an optional argument that defaults to 'False', which produces an unsigned conversion. |
Usage notes
- The inverse of the BinaryToInteger method is IntegerToBinary.
Examples
Several examples follow.
- 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}