Expand Minimize

InterlockedBitTestAndSet function

Tests the specified bit of the specified LONG value and sets it to 1. The operation is atomic.

Syntax


UCHAR WINAPI InterlockedBitTestAndSet(
  _In_  LONG volatile *Base,
  _In_  LONG Bit
);

Parameters

Base [in]

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 is implemented using a compiler intrinsic where possible. For more information, see the WinBase.h header file and _interlockedbittestandset.

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

Note  This function is supported on Windows RT-based systems.

Requirements

Header

Winnt.h (include Windows.h)

See also

Interlocked Variable Access
InterlockedBitTestAndReset
InterlockedBitTestAndResetAcquire
InterlockedBitTestAndResetRelease
InterlockedBitTestAndReset64
InterlockedBitTestAndSetAcquire
InterlockedBitTestAndSetRelease
InterlockedBitTestAndSet64
Synchronization Functions

 

 

Community Additions

ADD
Show:
© 2014 Microsoft