Important: The information in this document is obsolete and should not be used for new development.
OTAtomicClearBit
Clears a bit in a byte.C INTERFACE
Boolean OTAtomicClearBit( UInt8* bytePtr, size_t bitToClear)CC++ INTERFACE
None. C++ applications use the C interface to this function.PARAMETERS
bytePtr
- A pointer to the byte containing the bit to clear.
bitToClear
- A value ranging from 0 to 7 that specifies the bit to clear.
- function result
- Returns the previous state of the bit:
true
if the bit was set;false
, otherwise.DISCUSSION
This function atomically clears the bit specified by thebitToClear
parameter, in the byte referenced by thebytePtr
parameter. This function returns the previous state of the bit.No error checking is done on the
bitToClear
value you specify, and results are undefined if the value lies outside the range 0 through 7.Use the
OTAtomicSetBit
function to set a bit value.Use the
OTAtomicTestBit
function to test a bit value.