Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

Monitor.TryEnter Method (Object, TimeSpan)

.NET Framework 4

Attempts, for the specified amount of time, to acquire an exclusive lock on the specified object.

Namespace:  System.Threading
Assembly:  mscorlib (in mscorlib.dll)
C#
C++
F#
VB
Copy 
public static bool TryEnter(
	Object obj,
	TimeSpan timeout
)

Parameters

obj
Type: System.Object
The object on which to acquire the lock.
timeout
Type: System.TimeSpan
A TimeSpan representing the amount of time to wait for the lock. A value of –1 millisecond specifies an infinite wait.

Return Value

Type: System.Boolean
true if the current thread acquires the lock without blocking; otherwise, false.
Exception Condition
ArgumentNullException

The obj parameter is null.

ArgumentOutOfRangeException

The value of timeout in milliseconds is negative and is not equal to Infinite (–1 millisecond), or is greater than MaxValue.

If the value of the timeout parameter converted to milliseconds equals –1, this method is equivalent to Enter. If the value of timeout equals 0, this method is equivalent to TryEnter.

Note Note

Use Monitor to lock objects (that is, reference types), not value types. For details, see Enter and the conceptual topic Monitors.

.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

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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ