Windows Dev Center

Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

SemaphoreSlim.WaitAsync Method (TimeSpan, CancellationToken)

.NET Framework 4.6 and 4.5

Asynchronously waits to enter the SemaphoreSlim, using a TimeSpan to measure the time interval, while observing a CancellationToken.

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

public Task<bool> WaitAsync(
	TimeSpan timeout,
	CancellationToken cancellationToken
)

Parameters

timeout
Type: System.TimeSpan

A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.

cancellationToken
Type: System.Threading.CancellationToken

The CancellationToken token to observe.

Return Value

Type: System.Threading.Tasks.Task<Boolean>
A task that will complete with a result of true if the current thread successfully entered the SemaphoreSlim, otherwise with a result of false.

ExceptionCondition
ArgumentOutOfRangeException

millisecondsTimeout is a negative number other than -1, which represents an infinite time-out

-or-

timeout is greater than MaxValue.

OperationCanceledException

cancellationToken was canceled.

.NET Framework

Supported in: 4.6, 4.5

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Show:
© 2015 Microsoft