Clear Bit in String (CLRBTS)

Instruction Syntax

Op Code (Hex) Operand 1 Operand 2
102E Receiver Offset
Operand 1: Character variable scalar or numeric variable scalar.

Operand 2: Binary scalar.

Bound Program Access
Built-in number for CLRBTS is 2.
CLRBTS (
        receiver   : address
        offset     : unsigned binary(4)
)
The offset parameter must be between 0 and 65,535.

Description:

Clears the bit of the receiver operand as indicated by the bit offset operand.

The selected bit from the receiver operand is set to a value of binary 0.

The receiver operand can be character or numeric. The leftmost bytes of the receiver operand are used in the operation. The receiver operand is interpreted as a bit string with the bits numbered left to right from 0 to the total number of bits in the string minus 1.

The receiver cannot be a variable substring.

The offset operand indicates which bit of the receiver operand is to be cleared, with an offset of zero indicating the leftmost bit of the leftmost byte of the receiver operand.

If an offset value less than zero or beyond the length of the string is specified, a scalar value invalid (hex 3203) exception is signaled.

Authorization Required

  • None

Lock Enforcement

  • None

Exceptions

  • 06 Addressing
    • 0601 Space Addressing Violation
    • 0602 Boundary Alignment
    • 0603 Range
  • 08 Argument/Parameter
    • 0801 Parameter Reference Violation
  • 10 Damage Encountered
    • 1004 System Object Damage State
    • 1044 Partial System Object Damage
  • 1C Machine-Dependent
    • 1C03 Machine Storage Limit Exceeded
  • 20 Machine Support
    • 2002 Machine Check
    • 2003 Function Check
  • 22 Object Access
    • 2202 Object Destroyed
    • 2203 Object Suspended
    • 2208 Object Compressed
    • 220B Object Not Available
  • 24 Pointer Specification
    • 2401 Pointer Does Not Exist
    • 2402 Pointer Type Invalid
  • 2E Resource Control Limit
    • 2E01 User Profile Storage Limit Exceeded
  • 32 Scalar Specification
    • 3201 Scalar Type Invalid
    • 3203 Scalar Value Invalid
  • 36 Space Management
    • 3601 Space Extension/Truncation
  • 44 Protection Violation
    • 4401 Object Domain or Hardware Storage Protection Violation
    • 4402 Literal Values Cannot Be Changed