SemaphoreSlim.Wait Method (Int32, CancellationToken)

Article
11/23/2015

[ 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 32-bit signed integer that specifies the timeout, while observing a CancellationToken.

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

Syntax

Public Function Wait ( _
    millisecondsTimeout As Integer, _
    cancellationToken As CancellationToken _
) As Boolean

public bool Wait(
    int millisecondsTimeout,
    CancellationToken cancellationToken
)

Parameters

millisecondsTimeout
Type: System..::.Int32
The number of milliseconds to wait, or Infinite(-1) to wait indefinitely.

cancellationToken
Type: System.Threading..::.CancellationToken
The CancellationToken to observe.

Return Value

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

Exceptions

Exception	Condition
OperationCanceledException	cancellationToken was canceled.
ArgumentOutOfRangeException	millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.
ObjectDisposedException	The SemaphoreSlim instance has been disposed, or the CancellationTokenSourcethat created cancellationToken has been disposed.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0