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.
Assembly: mscorlib (in mscorlib.dll)
'Declaration Public Function Wait ( _ timeout As TimeSpan, _ cancellationToken As CancellationToken _ ) As 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 to observe.
Return Value
Type: System.Booleantrue if the current thread successfully entered the SemaphoreSlim; otherwise, false.
| 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. |