AsyncReaderWriterLock.WriteLockAsync Method

Definition

Overloads

WriteLockAsync(CancellationToken)

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

WriteLockAsync(AsyncReaderWriterLock+LockFlags, CancellationToken)

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

WriteLockAsync(CancellationToken)

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

public Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable WriteLockAsync (System.Threading.CancellationToken cancellationToken = default);
member this.WriteLockAsync : System.Threading.CancellationToken -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable
Public Function WriteLockAsync (Optional cancellationToken As CancellationToken = Nothing) As AsyncReaderWriterLock.Awaitable

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

WriteLockAsync(AsyncReaderWriterLock+LockFlags, CancellationToken)

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

public Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable WriteLockAsync (Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default);
member this.WriteLockAsync : Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags * System.Threading.CancellationToken -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable
Public Function WriteLockAsync (options As AsyncReaderWriterLock.LockFlags, Optional cancellationToken As CancellationToken = Nothing) As AsyncReaderWriterLock.Awaitable

Parameters

options
AsyncReaderWriterLock.LockFlags

Modifications to normal lock behavior.

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