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.
Assembly: mscorlib (in mscorlib.dll)
'Declaration Public Shared Sub TryEnter ( _ obj As Object, _ ByRef lockTaken As Boolean _ )
- Type: System.Object
The object on which to acquire 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 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. If the thread cannot enter without blocking, the method returns false, and the thread does not enter the critical section.
The following code shows the basic pattern for using the 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.
Dim acquiredLock As Boolean = False Try Monitor.TryEnter(lockObject, acquiredLock) If acquiredLock Then ' Code that accesses resources that are protected by the lock. Else ' Code to deal with the fact that the lock was not acquired. End If Finally If acquiredLock Then Monitor.Exit(lockObject) End If End Try
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.