InterlockedCompareExchange

InterlockedCompareExchange performs an atomic compare-and-exchange operation on the specified values. The function compares two specified 32-bit values and exchanges with another 64-bit value based on the comparison outcome.

Syntax

Copy

LONG InterlockedCompareExchange(
    [in, out]  LONG volatile *Destination,
    [in]       LONG           Exchange,
    [in]       LONG           Comparand  
  );

Parameters

[in, out] Destination

A pointer to the destination value.

[in] Exchange

The exchange value.

[in] 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 parameters for this function must be aligned on a 32-bit boundary; otherwise, the function will behave unpredictably on multiprocessor x64 systems.

The interlocked functions provide a simple mechanism for synchronizing access to a variable shared by multiple threads. This function is atomic concerning calls to other interlocked functions. It is thread-safe.

This function is implemented using a compiler intrinsic where possible. This function generates a full memory barrier (or fence) to ensure that memory operations are completed properly.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	windows.h	wRTOS_rtss.lib