InterlockedCompareExchangePointer function (Windows)

Switch View :

ScriptFree

InterlockedCompareExchangePointer function

Applies to: desktop apps | Metro style apps

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.

To operate on non-pointer values, use the InterlockedCompareExchange function.

Syntax

PVOID __cdecl InterlockedCompareExchangePointer(
  __inout  PVOID volatile *Destination,
  __in     PVOID Exchange,
  __in     PVOID Comparand
);

Parameters

Destination [in, out]: A pointer to a pointer to the destination value.
Exchange [in]: The exchange value.
Comparand [in]: 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.

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

Itanium-based systems: For performance-critical applications, use InterlockedCompareExchangePointerAcquire or InterlockedCompareExchangePointerRelease instead.

Requirements

Minimum supported client	Windows XP
Minimum supported server	Windows Server 2003
Header	WinBase.h (include Windows.h)