Interlocked.CompareExchange Method (Object, Object, Object)

 

Compares two objects for reference equality and, if they are equal, replaces the first object.

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

Public Shared Function CompareExchange (
	ByRef location1 As Object,
	value As Object,
	comparand As Object
) As Object

Parameters

location1
Type: System.Object

The destination object that is compared with comparand and possibly replaced.

value
Type: System.Object

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

comparand
Type: System.Object

The object that is compared to the object at location1.

Return Value

Type: System.Object

The original value in location1.

Exception Condition
ArgumentNullException

The address of location1 is a null pointer.

If comparand and the object 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.

Beginning with .NET Framework version 2.0, the CompareExchange(Of T)(T, T, T) method overload provides a type-safe alternative for reference types.

System_CAPS_noteNote

The objects are compared for reference equality, rather than Object.Equals. As a result, two boxed instances of the same value type (for example, the integer 3) always appear to be unequal, and no operation is performed. Do not use this overload with value types.

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