Function subtract

  • subtract(bin, bitOffset, bitSize, value, sign): OverflowableBitwiseOp

  • Create bit "subtract" operation.

    Parameters

    • bin: string

      The name of the bin. The bin must contain a byte value.

    • bitOffset: number

      Offset in bits.

    • bitSize: number

      Number of bits; must be <= 64.

    • value: number

      Value to subtract.

    • sign: boolean

      Sign indicates if bits should be treated as a signed number.

    Returns OverflowableBitwiseOp

    Operation that can be passed to the Client#operate command.

    Remarks

    Server subtracts value from bitmap. Server does not return a value.

    See

    ~OverflowableBitwiseOp#onOverflow|OverflowableBitwiseOp#onOverflow can used to control how the operation executes, when the addition results in an overflow/underflow.

Settings

Member Visibility
MMNEPVFCICPMFPCPTTAAATR