BinaryToInteger (String function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| Line 5: | Line 5: | ||
==Syntax== | ==Syntax== | ||
{{Template:String:BinaryToInteger syntax}} | {{Template:String:BinaryToInteger syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%number</th> | <tr><th>%number</th> | ||
<td>A numeric variable to receive the integer value of the method object <var class="term">string</var>.</td></tr> | <td>A numeric variable to receive the integer value of the method object <var class="term">string</var>.</td></tr> | ||
<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><var>Signed</var></th> | <tr><th><var>Signed</var></th> | ||
<td>This is an optional, but | <td>This is an optional, but [[Notation conventions for methods#Named parameters|name required]], 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>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> | ||
==Usage notes== | ==Usage notes== | ||
<ul><li>The <var>BinaryToInteger</var> function is available as of <var class="product"> | <ul> | ||
<li>The <var>BinaryToInteger</var> function is available as of <var class="product">Sirius Mods</var> version 7.3. | |||
</ul> | |||
==Examples== | ==Examples== | ||
<ol><li>The following statement displays <code>240</code>: | <ol> | ||
<li>The following statement displays <code>240</code>: | |||
<p class="code">[[PrintText statement|printText]] {'0':binaryToInteger} | <p class="code">[[PrintText statement|printText]] {'0':binaryToInteger} | ||
</p> | </p> | ||
| Line 39: | Line 49: | ||
==See also== | ==See also== | ||
<ul><li>The inverse of <var>BinaryToInteger</var> is <var>[[IntegerToBinary (Float function)|IntegerToBinary]]</var>.</ul> | <ul> | ||
<li>The inverse of <var>BinaryToInteger</var> is <var>[[IntegerToBinary (Float function)|IntegerToBinary]]</var>. | |||
</ul> | |||
{{Template:String:BinaryToInteger footer}} | {{Template:String:BinaryToInteger footer}} | ||
Revision as of 18:40, 2 November 2012
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 name required, 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.