SemaphoreSlim.WaitAsync Method (TimeSpan, CancellationToken)

May 11, 2014

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

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

'Declaration
Public Function WaitAsync ( _
	timeout As TimeSpan, _
	cancellationToken As CancellationToken _
) As Task(Of Boolean)

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(Of 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.

Windows Phone OS

Supported in: 8.1, 8.0

Show:
© 2014 Microsoft