Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Wait Method (CancellationToken)

SemaphoreSlim.Wait Method (CancellationToken)

.NET Framework 4.6 and 4.5

Blocks the current thread until it can enter the SemaphoreSlim, while observing a CancellationToken.

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

public void Wait(
	CancellationToken cancellationToken
)

Parameters

cancellationToken
Type: System.Threading.CancellationToken

The CancellationToken token to observe.

ExceptionCondition
OperationCanceledException

cancellationToken was canceled.

ObjectDisposedException

The current instance has already been disposed.

-or-

The CancellationTokenSource that created cancellationToken has already been disposed.

If a thread or task is able to enter the semaphore, it decrements the CurrentCount property by one.

If cancellationToken is cancelled, the thread or task doesn’t enter the semaphore, and the CurrentCount property isn’t decremented. Instead, the method throws an OperationCanceledException exception.

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Portable Class Library

Supported in: Portable Class Library
Show:
© 2015 Microsoft