BinaryToInteger (String function): Difference between revisions
		
		
		
		Jump to navigation
		Jump to search
		
| m first pass, match syntax diagram to template and fix tags; still some broken links | |||
| Line 12: | Line 12: | ||
| <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 class="term">Signed</var></th> | <tr><th><var class="term">Signed</var></th> | ||
| <td>This is an optional, but <var>[[Methods#Named parameters|NameRequired]]</var>, argument is a <var>[[boolean enumeration]]</var>; if you specify a value, the parameter name <var class="term">Signed</var> is required.<p><var class="term">Signed</var> is a <var>[[boolean enumeration]]</var> value that indicates whether the method object string is converted to a signed integer.  | <td>This is an optional, but <var>[[Methods#Named parameters|NameRequired]]</var>, argument is a <var>[[boolean enumeration]]</var>; if you specify a value, the parameter name <var class="term">Signed</var> is required.<p><var class="term">Signed</var> is a <var>[[boolean enumeration]]</var> value that indicates whether the method object string is converted to a signed integer.<ul><li><var class="term">Signed</var> is an optional argument that 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></p></td></tr> | ||
| </table> | </table> | ||
Revision as of 06:11, 31 January 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; if you specify a value, the parameter name Signed is required. Signed is a boolean enumeration value that indicates whether the method object string is converted to a signed integer. 
 | 
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
- For information about the PrintText statement, pleae see printText.
- The inverse of BinaryToInteger is IntegerToBinary.