InterlockedCompareExchangePointerAcquire function

Performs an atomic compare-and-exchange operation on the specified values. The function compares two specified pointer values and exchanges with another pointer value based on the outcome of the comparison. The operation is performed with acquire memory ordering semantics.

Syntax

PVOID __cdecl InterlockedCompareExchangePointerAcquire(
  _Inout_  PVOID volatile *Destination,
  _In_opt_ PVOID          Exchange,
  _In_opt_ PVOID          Comparand
);

Parameters

  • Destination [in, out]
    A pointer to a pointer to the destination value.

  • Exchange [in, optional]
    The exchange value.

  • Comparand [in, optional]
    The value to compare to Destination.

Return value

The function returns the initial value of the Destination parameter.

Remarks

The function compares the Destination value with the Comparand value. If the Destination value is equal to the Comparand value, the Exchange value is stored in the address specified by Destination. Otherwise, no operation is performed.

On a 64-bit system, the parameters are 64 bits and must be aligned on 64-bit boundaries; otherwise, the function will behave unpredictably. On a 32-bit system, the parameters are 32 bits and must be aligned on 32-bit boundaries.

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 _InterlockedCompareExchangePointer_acq.

For processors that do not support acquire memory ordering semantics, this function is defined as a call to the InterlockedCompareExchangePointer function. For more information, see WinBase.h.

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

 

Requirements

Header

WinBase.h (include Windows.h)

See also

Interlocked Variable Access

InterlockedCompare64Exchange128

InterlockedCompareExchange

InterlockedCompareExchangeAcquire

InterlockedCompareExchangeRelease

InterlockedCompareExchangeNoFence

InterlockedCompareExchange16

InterlockedCompareExchange16Acquire

InterlockedCompareExchange16Release

InterlockedCompareExchange16NoFence

InterlockedCompareExchange64

InterlockedCompareExchangeAcquire64

InterlockedCompareExchangeRelease64

InterlockedCompareExchangeNoFence64

InterlockedCompareExchange128

InterlockedCompareExchangePointer

InterlockedCompareExchangePointerRelease

InterlockedCompareExchangePointerNoFence

Synchronization Functions