BitValueString (String function)

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

%value	Set 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

• 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

The following example shows a bit in a string being tested based on a field value:

%bitmap is string len 32 ... for record %record if %bitmap:bitValueString(stateCode) eq 0 then ... retrieve information for state %bitmap:bitSetString(statecode) end if end for

See also

BitAndString BitOffString BitOnString BitOrString BitXorString

BitClearString, BitFlipString, and BitSetString BitCountString

Float class String class Unicode class	List of Float methods List of String methods List of Unicode methods List of Intrinsic methods	Float methods syntax String methods syntax Unicode methods syntax
Notation conventions for methods