ReaderWriterLockSlim::TryEnterReadLock Method (TimeSpan)

.NET Framework (current version)

Tries to enter the lock in read mode, with an optional time-out.

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

Syntax

public:
bool TryEnterReadLock(
	TimeSpan timeout
)

Parameters

timeout: Type: System::TimeSpan
The interval to wait, or -1 milliseconds to wait indefinitely.

Return Value

Type: System::Boolean

true if the calling thread entered read mode, otherwise, false.

Exceptions

Exception	Condition
LockRecursionException	The RecursionPolicy property is LockRecursionPolicy::NoRecursion and the current thread has already entered the lock. -or- The recursion number would exceed the capacity of the counter. The limit is so large that applications should never encounter it.
ArgumentOutOfRangeException	The value of timeout is negative, but it is not equal to -1 milliseconds, which is the only negative value allowed. -or- The value of timeout is greater than Int32::MaxValue milliseconds.
ObjectDisposedException	The ReaderWriterLockSlim object has been disposed.

Remarks

If timeout is 0 (zero), this method checks the lock state and returns false immediately if the desired state is unavailable.

Multiple threads can enter the lock in read mode at the same time.

If one or more threads are queued to enter write mode, a thread that calls the TryEnterReadLock method blocks until those threads have either timed out or entered write mode and then exited from it, or until the calling thread's own time-out interval expires.

Note
If a lock allows recursion, a thread that has entered the lock in read mode can enter read mode recursively, even if other threads are waiting to enter write mode.

One thread can be in upgradeable mode while other threads are in read mode. If additional threads are waiting to enter upgradeable mode, and there are no threads waiting to enter write mode, threads that call the TryEnterReadLock method enter read mode immediately and do not block.

Version Information

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