BitValueString (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Template:String:BitValueString subtitle}}
{{Template:String:BitValueString subtitle}}
 
This function returns the "value" of a bit in a string: 0 if the requested bit number is off, 1 if it is on.
This page is [[under construction]].
==Syntax==
==Syntax==
{{Template:String:BitValueString syntax}}
{{Template:String:BitValueString syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%value</th><td>number</td></tr>
<tr><th>%value</th><td>Set to 0 if the requested but number was off, and 1 if it was on.</td></tr>
<table class="syntaxTable">
<tr><th>string</th>
<tr><th>string</th>
<td>string</td></tr>
<td>The string for which a bit is to be tested.</td></tr>
<tr><th>bitNumber</th>
<tr><th>bitNumber</th>
<td>number</td></tr>
<td>The bit number in the input string that is to be tested. Note that this is a bit number not a bit offset. So the first bit in the string is bit number 1.</td></tr>
</table>
</table>
==Usage notes==
==Usage notes==

Revision as of 01:07, 22 March 2013

Get bit value (0 or 1) in a string (String class)

[Introduced in Model 204 7.5]

This function returns the "value" of a bit in a string: 0 if the requested bit number is off, 1 if it is on.

Syntax

%value = string:BitValueString( bitNumber) Throws InvalidBitNumber

Syntax terms

%valueSet to 0 if the requested but number was off, and 1 if it was on.
string The string for which a bit is to be tested.
bitNumber The bit number in the input string that is to be tested. Note that this is a bit number not a bit offset. So the first bit in the string is bit number 1.

Usage notes

Examples

See also