This documentation is archived and is not being maintained.

Monitor.TryEnter Method (Object, TimeSpan)

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

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

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.

ExceptionCondition
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.

NoteNote:

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

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.

.NET Framework

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