.NET Framework Class Library
Interlocked..::.CompareExchange Method (Int64%, Int64, Int64)

Compares two 64-bit signed integers for equality and, if they are equal, replaces one of the values.

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

Visual Basic (Declaration)
Public Shared Function CompareExchange ( _
    ByRef location1 As Long, _
    value As Long, _
    comparand As Long _
) As Long
Visual Basic (Usage)
Dim location1 As Long
Dim value As Long
Dim comparand As Long
Dim returnValue As Long

returnValue = Interlocked.CompareExchange(location1, _
    value, comparand)
C#
public static long CompareExchange(
    ref long location1,
    long value,
    long comparand
)
Visual C++
public:
static long long CompareExchange(
    long long% location1, 
    long long value, 
    long long comparand
)
JScript
public static function CompareExchange(
    location1 : long, 
    value : long, 
    comparand : long
) : long

Parameters

location1
Type: System..::.Int64%
The destination, whose value is compared with comparand and possibly replaced.
value
Type: System..::.Int64
The value that replaces the destination value if the comparison results in equality.
comparand
Type: System..::.Int64
The value that is compared to the value at location1.

Return Value

Type: System..::.Int64
The original value in location1.
Exceptions

ExceptionCondition
NullReferenceException

The address of location1 is a null pointer.

Remarks

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.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0
See Also

Reference

Other Resources

Tags :


Page view tracker