bitclear()

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

Syntax

bitclear(binary1,firstbitnumber[,lastbitnumber=firstbitnumber])

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.

• Bit numbers start at 0
• Bit 0 is the Most Significant Bit

When executing on the client, the binary argument must be a 32-bit integer variable (as binary variables are not sent to the client).

Example

Calculate
 
lStatus
 as 
bitclear
(
lBinary1
,
lFirstBitNumber
,
lLastBitNumber
)