|
| .NET Framework Class Library |
| SemaphoreSlim..::.Wait Method (TimeSpan, CancellationToken) |
| SemaphoreSlim Class See Also Send Feedback |
Blocks the current thread until it can enter the SemaphoreSlim, using a TimeSpan to measure the time interval, while observing a CancellationToken.
Namespace:
System.Threading
Assembly:
System.Threading (in System.Threading.dll)
Syntax
| Visual Basic (Declaration) |
|---|
Public Function Wait ( _ timeout As TimeSpan, _ cancellationToken As CancellationToken _ ) As Boolean |
| C# |
|---|
public bool Wait( 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 to observe.
Return Value
true if the current thread successfully entered the SemaphoreSlim; otherwise, false.
Exceptions
| Exception | Condition |
|---|---|
| System..::.ArgumentOutOfRangeException | timeout is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than MaxValue. |
| System..::.OperationCanceledException | cancellationToken was canceled. |