bitclear()

Function group Execute on client Platform(s)
Binary Field NO All
Binary Field YES All

Syntax

bitclear(binary1,firstbitnumber,lastbitnumber)

Description

Clears a range of bits (all bits with numbers >=firstBitNumber and <=lastBitNumber) operating directly on binary. Returns a Boolean (true for success).

The function operates directly on the binary1 argument, and returns 1 for success and 0 for failure. If the bit numbers identify some bits which are outside the current length of the binary field, Omnis extends the field by appending bytes with value zero, and clears the bits.

The first parameter can be a Binary or an Integer; in the case of Binary, you need to provide a variable, and not the result of a calculation.

When executing on the client, the binary argument must be a 32-bit integer variable.

See also bitset() and bittest.

Example

Calculate lStatus as  bitclear(lBinary1,lFirstBitNumber,lLastBitNumber)