Share via


AsyncReaderWriterResourceLock<TMoniker,TResource>.ReadLockAsync Method

Definition

Obtains a read lock, asynchronously awaiting for the lock if it is not immediately available.

public Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock<TMoniker,TResource>.ResourceAwaitable ReadLockAsync (System.Threading.CancellationToken cancellationToken = default);
override this.ReadLockAsync : System.Threading.CancellationToken -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock<'Moniker, 'Resource (requires 'Resource : null)>.ResourceAwaitable
Public Function ReadLockAsync (Optional cancellationToken As CancellationToken = Nothing) As AsyncReaderWriterResourceLock(Of TMoniker, TResource).ResourceAwaitable

Parameters

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.

Applies to