Monitor::TryEnter Method (Object^, Boolean%)

 

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

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

public:
static void TryEnter(
	Object^ obj,
	bool% lockTaken
)

Parameters

obj
Type: System::Object^

The object on which to acquire the lock.

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.

Exception Condition
ArgumentException

The input to lockTaken is true.

ArgumentNullException

The obj parameter is null.

If successful, this method acquires an exclusive lock on the obj parameter. This method returns immediately, whether or not the lock is available.

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.

This method is similar to Enter(Object^, Boolean%), but it will never block the current thread. If the thread cannot enter without blocking, the lockTaken argument is set to false when the method returns.

System_CAPS_noteNote

Use Monitor to lock objects (that is, reference types), not value types. For more information, see the Monitor article.

To ensure that the thread does not enter the critical section, you should examine the value of lockTaken and execute code in the critical section only if its 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.

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

The following code shows the basic pattern for using the TryEnter(Object^, Boolean%) method overload. This overload always sets the value of the variable that is passed to the ref parameter (ByRef in Visual Basic) lockTaken, even if the method throws an exception, so the value of the variable is a reliable way to test whether the lock has to be released.

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

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 4.0
Windows Phone Silverlight
Available since 7.1
Windows Phone
Available since 8.1
Return to top
Show: