Monitor::TryEnter Method (Object^, TimeSpan)

.NET Framework (current version)

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

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

Syntax

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; otherwise, false.

Exceptions

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.

Remarks

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
Use Monitor to lock objects (that is, reference types), not value types. For details, see the Monitor class topic.

To ensure that the thread does not enter the critical section, you should examine the method's return value and execute code in the critical section only if its return value is true. The following code fragment shows the pattern used to call this method. Note that you should call Exit in a finally block to ensure that the calling thread releases its lock on the critical section if an exception occurs.

C++

No code example is currently available or this language may not be supported.

Version Information

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1