BinaryToInteger (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (re-match syntax diagram to revised template; fix tags. Still some link targets that need to be found / written.)
m (printtext)
Line 16: Line 16:


==Usage notes==
==Usage notes==
<ul><li>The <var>BinaryToInteger</var> function is available as of <var class=product>Sirius Mods</var> version 7.3.</ul>
<ul><li>The <var>BinaryToInteger</var> function is available as of <var class="product">[[Sirius Mods|"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 {'0':binaryToInteger}
<p class="code">[[PrintText statement|printText]] {'0':binaryToInteger}
</p>
</p>


Line 39: Line 39:


==See also==
==See also==
<ul><li>For information about the PrintText statement, pleae see <var>[[Intrinsic classes#printtext|printText]]</var>.
<ul><li>The inverse of <var>BinaryToInteger</var> is <var>[[IntegerToBinary (Float function)|IntegerToBinary]]</var>.</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 11:25, 22 February 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.
  • Signed defaults to False, which produces an unsigned conversion.
  • If Signed=True, the method object string 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.

Usage notes

  • The BinaryToInteger function is available as of "Sirius Mods" version 7.3.

Examples

  1. The following statement displays 240:

    printText {'0':binaryToInteger}

  2. The following statement displays 61680:

    printText {'00':binaryToInteger}

  3. The result of the following pair of statements is -3856:

    %string = '00' printText {%string:binaryToInteger(signed=true)}

  4. The result of the following pair of statements is 0:

    %string = '00':hexToString printText {%string:binaryToInteger}

See also