Interlocked.Decrement Method (Int64) (System.Threading)

Switch View :
ScriptFree
.NET Framework Class Library
Interlocked.Decrement Method (Int64%)

Decrements the specified variable and stores the result, as an atomic operation.

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

Visual Basic
Public Shared Function Decrement ( _
	ByRef location As Long _
) As Long
C#
public static long Decrement(
	ref long location
)
Visual C++
public:
static long long Decrement(
	long long% location
)
F#
static member Decrement : 
        location:int64 byref -> int64 

Parameters

location
Type: System.Int64%
The variable whose value is to be decremented.

Return Value

Type: System.Int64
The decremented value.
Exceptions

Exception Condition
ArgumentNullException

The address of location is a null pointer.

Remarks

This method handles an overflow condition by wrapping: if location = Int64.MinValue, location - 1 = Int64.MaxValue. No exception is thrown.

The Read method and the 64-bit overloads of the Increment, Decrement, and Add methods are truly atomic only on systems where a System.IntPtr is 64 bits long. On other systems, these methods are atomic with respect to each other, but not with respect to other means of accessing the data. Thus, to be thread safe on 32-bit systems, any access to a 64-bit value must be made through the members of the Interlocked class.

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
See Also

Reference

Add

Other Resources