This documentation is archived and is not being maintained.

SemaphoreSlim.Wait Method (Int32, CancellationToken)

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)

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.

ExceptionCondition
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.

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: