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.
Assembly: mscorlib (in mscorlib.dll)
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.
| Exception | Condition |
|---|---|
| ArgumentException | The input to lockTaken is true. |
| ArgumentNullException | The obj parameter is nullptr. |
| 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.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Note