Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

Monitor.TryEnter Method (Object, TimeSpan, Boolean)

Attempts, for the specified amount of time, to acquire an exclusive lock on the specified object, and atomically sets a value that indicates whether the lock was taken.

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

static member TryEnter : 
        obj:Object * 
        timeout:TimeSpan * 
        lockTaken:bool byref -> unit

Parameters

obj
Type: System.Object

The object on which to acquire the lock.

timeout
Type: System.TimeSpan

The amount of time to wait for the lock. A value of –1 millisecond specifies an infinite wait.

lockTaken
Type: System.Boolean

The result of the attempt to acquire the lock, passed by reference. The input must be false. The output is true if the lock is acquired; otherwise, the output is false. The output is set even if an exception occurs during the attempt to acquire the lock.

ExceptionCondition
ArgumentException

The input to lockTaken is true.

ArgumentNullException

The obj parameter is a null reference (Nothing in Visual Basic).

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(Object). If the value of timeout equals 0, this method is equivalent to TryEnter(Object).

If the lock was not taken because an exception was thrown, the variable specified for the lockTaken parameter is false after this method ends. This allows the program to determine, in all cases, whether it is necessary to release the lock.

NoteNote

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

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Show:
© 2015 Microsoft