InterlockedBitTestAndComplement function

Article
2018-03-28

Tests the specified bit of the specified LONG value and complements it. The operation is atomic.

Syntax

FORCEINLINE BOOLEAN FORCEINLINE InterlockedBitTestAndComplement(
  _Inout_ LONG volatile *Base,
  _In_    LONG          Bit
);

Parameters

Base [in, out]
A pointer to a variable.
Bit [in]
The bit position to be tested.

Return value

The value of the specified bit.

Remarks

The interlocked functions provide a simple mechanism for synchronizing access to a variable that is shared by multiple threads. This function is atomic with respect to calls to other interlocked functions.

This function generates a full memory barrier (or fence) to ensure that memory operations are completed in order.

Requirements

Minimum supported client	Windows Vista [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2003 [desktop apps \| UWP apps]
Header	Winnt.h (include Windows.h)

Share via