SemaphoreSlim.WaitAsync Method (CancellationToken)

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Asynchronously waits to enter the SemaphoreSlim, while observing a CancellationToken.

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

Public Function WaitAsync (
	cancellationToken As CancellationToken
) As Task

Parameters

cancellationToken
Type: System.Threading.CancellationToken

The CancellationToken token to observe.

Return Value

Type: System.Threading.Tasks.Task

A task that will complete when the semaphore has been entered.

Exception Condition
ObjectDisposedException

The current instance has already been disposed.

OperationCanceledException

cancellationToken was canceled.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.5
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top
Show: