InterlockedCompareExchangePointer

InterlockedCompareExchangePointer 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 InterlockedCompareExchangePointer(
        PVOID volatile *Destination,
        PVOID          Exchange,
        PVOID          Comparand
);

Parameters

Destination

A pointer to the destination value.

Exchange

The exchange value.

Comparand

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. The variable pointed to by the Destination parameter must be aligned on a 128-bit boundary.

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.

Requirements

Minimum Supported Version	RTX64 3.1
Header	windows.h
Library	Rtx_Rtss.lib