CompareExchange Method (Single, Single, Single)

Interlocked.CompareExchange Method (Single%, Single, Single)

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Compares two single-precision floating point numbers for equality and, if they are equal, replaces one of the values.

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

'Declaration
Public Shared Function CompareExchange ( _
	ByRef location1 As Single, _
	value As Single, _
	comparand As Single _
) As Single

Parameters

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

Return Value

Type: System.Single
The original value in location1.

ExceptionCondition
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 of Single values. Two threads add a series of Single values using the thread-safe method and ordinary addition, and when the threads complete the totals are compared. On a dual-processor computer, there is a significant difference in the totals.

In the thread-safe method, 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.

Windows Phone OS

Supported in: 8.1, 8.0

Show:
© 2017 Microsoft