Monitor::TryEnter Method (Object, Int32, Boolean%)
Attempts, for the specified number of milliseconds, to acquire an exclusive lock on the specified object, and atomically sets a value that indicates whether the lock was taken.
Assembly: mscorlib (in mscorlib.dll)
public: static void TryEnter( Object^ obj, int millisecondsTimeout, bool% lockTaken )
- Type: System::Object
The object on which to acquire the lock.
- Type: System::Int32
The number of milliseconds to wait for the lock.
- 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.
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.
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.