Gambas Documentation - /lang/btst

/lang/btst

# BTst

Result = BTst ( Number , Bit )

Return TRUE if the Bitth bit of the Number is set. The bit number of the least significant bit is 0.

The type of Number may be Byte, Short, Integer, or Long.

The valid range of Bit depends on the type of the Number argument.

Type of Number | Range of Bit
--- | ---
Byte | 0...7
Short | 0...15
Integer | 0...31
Long | 0...63

### Errors

Message | Description
--- | ---
Type mismatch (6) | The datatype of the Number argument is not valid.
Bad argument (20) | The Bit argument is out of range.

### Examples

    Print 15, Bin(15, 16)
    Print BTst(15, 1)

    15      0000000000001111
    True

    Print 13, Bin(13, 16)
    Print BTst(13, 1)

    13      0000000000001101
    False

### See also

- Bits Manipulation Functions

- Logical Operators