SemaphoreSlim::Wait Method (Int32)

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Blocks the current thread until it can enter the SemaphoreSlim, using a 32-bit signed integer that specifies the timeout.

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

public:
bool Wait(
	int millisecondsTimeout
)

Parameters

millisecondsTimeout
Type: System::Int32

The number of milliseconds to wait, or Infinite(-1) to wait indefinitely.

Return Value

Type: System::Boolean

true if the current thread successfully entered the SemaphoreSlim; otherwise, false.

Exception Condition
ArgumentOutOfRangeException

millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.

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

If a thread or task is blocked when calling Wait(Int32), and the time-out interval specified by millisecondsTimeout expires, the thread or task doesn’t enter the semaphore, and the CurrentCount property isn’t decremented.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top
Show: