SemaphoreSlim.Wait Method (TimeSpan, CancellationToken)

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Blocks the current thread until it can enter the SemaphoreSlim, using a TimeSpan that specifies the timeout, while observing a CancellationToken.

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

Syntax

Public Function Wait ( _
    timeout As TimeSpan, _
    cancellationToken As CancellationToken _
) As Boolean
public bool Wait(
    TimeSpan timeout,
    CancellationToken cancellationToken
)

Parameters

Return Value

Type: System..::.Boolean
true if the current thread successfully entered the SemaphoreSlim; otherwise, false.

Exceptions

Exception Condition
OperationCanceledException

cancellationToken was canceled.

ArgumentOutOfRangeException

timeout is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than MaxValue.

ObjectDisposedException

The semaphoreSlim instance has been disposed.

-or-

The CancellationTokenSource that created cancellationToken has already been disposed.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0

See Also

Reference

SemaphoreSlim Class

Wait Overload

System.Threading Namespace