AsyncReaderWriterLock.ReadLockAsync(CancellationToken) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Obtains a read lock, asynchronously awaiting for the lock if it is not immediately available.
public Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable ReadLockAsync(System.Threading.CancellationToken cancellationToken = default);member this.ReadLockAsync : System.Threading.CancellationToken -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AwaitablePublic Function ReadLockAsync (Optional cancellationToken As CancellationToken = Nothing) As AsyncReaderWriterLock.AwaitableParameters
- cancellationToken
- CancellationToken
A token whose cancellation indicates lost interest in obtaining the lock. A canceled token does not release a lock that has already been issued. But if the lock isn't immediately available, a canceled token will cause the code that is waiting for the lock to resume with an OperationCanceledException.
Returns
An awaitable object whose result is the lock releaser.
Exceptions
Thrown when Complete() has been called and this is a new top-level lock request.