Interlocked.CompareExchange Method (Int32, Int32, Int32)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Compares two 32-bit signed integers for equality and, if they are equal, replaces the first value.

Namespace:   System.Threading
Assembly:  mscorlib (in mscorlib.dll)

static member CompareExchange : 
        location1:int byref *
        value:int *
        comparand:int -> int

Parameters

location1
Type: System.Int32

The destination, whose value is compared with comparand and possibly replaced.

value
Type: System.Int32

The value that replaces the destination value if the comparison results in equality.

comparand
Type: System.Int32

The value that is compared to the value at location1.

Return Value

Type: System.Int32

The original value in location1.

Exception Condition
NullReferenceException

The address of location1 is a null pointer.

If comparand and the value in location1 are equal, then value is stored in location1. Otherwise, no operation is performed. The compare and exchange operations are performed as an atomic operation. The return value of CompareExchange is the original value in location1, whether or not the exchange takes place.

The following code example demonstrates a thread-safe method that accumulates a running total. The initial value of the running total is saved, and then the CompareExchange method is used to exchange the newly computed total with the old total. If the return value is not equal to the saved value of the running total, then another thread has updated the total in the meantime. In that case, the attempt to update the running total must be repeated.

System_CAPS_noteNote

The Add method, introduced in version 2.0 of the .NET Framework, provides a more convenient way to accumulate thread-safe running totals for integers.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show: