Interlocked.CompareExchange<T> Method (T%, T, T)
[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]
Compares two instances of the specified reference type T for equality and, if they are equal, replaces one of them.
Namespace: System.Threading
Assembly: mscorlib (in mscorlib.dll)
[ComVisibleAttribute(false)] public static T CompareExchange<T>( ref T location1, T value, T comparand ) where T : class
Type Parameters
- T
The type to be used for location1, value, and comparand. This type must be a reference type.
Parameters
- location1
- Type: T%
The destination, whose value is compared with comparand and possibly replaced. This is a reference parameter (ref in C#, ByRef in Visual Basic).
- value
- Type: T
The value that replaces the destination value if the comparison results in equality.
- comparand
- Type: T
The value that is compared to the value at location1.
Return Value
Type: TThe 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 comparison and the exchange are performed as an atomic operation. The return value of this method is the original value in location1, whether or not the exchange takes place.
This method only supports reference types. There are overloads of the CompareExchange method for the value types Int32, Int64, IntPtr, Single, and Double, but there is no support for other value types.
Note
|
|---|
|
This method overload is preferable to the CompareExchange(Object, Object, Object) method overload, because the latter requires the destination object to be accessed late-bound. |
Windows 8 Consumer Preview, Windows Server 8 Beta, Windows 7, Windows Server 2008 SP2, Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
