BitValueString (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
Line 11: Line 11:


==Usage notes==
==Usage notes==
==Usage notes==
<ul>
<li>Requesting a non-positive bit number, or a bit number past the the end of the string results in an [[InvalidBitNumber class|InvalidBitNumber exception]] being thrown.</li>
<li>Since each byte in a string has 8 bits, the valid bit numbers range from 1 to the length of the string times 8. So a null (zero-length) string has no valid bits.</li>
</ul>
==Examples==
==Examples==
==See also==
==See also==

Revision as of 01:09, 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.
stringThe string for which a bit is to be tested.
bitNumberThe 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

Usage notes

  • Requesting a non-positive bit number, or a bit number past the the end of the string results in an InvalidBitNumber exception being thrown.
  • Since each byte in a string has 8 bits, the valid bit numbers range from 1 to the length of the string times 8. So a null (zero-length) string has no valid bits.

Examples

See also