Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

ReaderWriterLockSlim.TryEnterReadLock Method (Int32)

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

Namespace:  System.Threading
Assembly:  System.Core (in System.Core.dll)
public bool TryEnterReadLock(
	int millisecondsTimeout
)

Parameters

millisecondsTimeout
Type: System.Int32

The number of milliseconds to wait, or -1 (Timeout.Infinite) to wait indefinitely.

Return Value

Type: System.Boolean
true if the calling thread entered read mode, otherwise, false.
ExceptionCondition
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 millisecondsTimeout is negative, but it is not equal to Timeout.Infinite (-1), which is the only negative value allowed.

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

Multiple threads can enter read mode at the same time.

If one or more threads are waiting 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.

NoteNote

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.

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.