WaitHandle.WaitOne Method (Int32) (System.Threading)

.NET Framework Class Library

WaitHandle..::.WaitOne Method (Int32)

Updated: July 2008

Blocks the current thread until the current WaitHandle receives a signal, using a 32-bit signed integer to measure the time interval.

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

Syntax

Visual Basic (Declaration)

Public Overridable Function WaitOne ( _
    millisecondsTimeout As Integer _
) As Boolean

Visual Basic (Usage)

Dim instance As WaitHandle
Dim millisecondsTimeout As Integer
Dim returnValue As Boolean

returnValue = instance.WaitOne(millisecondsTimeout)

public virtual bool WaitOne(
    int millisecondsTimeout
)

Visual C++

public:
virtual bool WaitOne(
    int millisecondsTimeout
)

JScript

public function WaitOne(
    millisecondsTimeout : int
) : boolean

Parameters

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

Return Value

Type: System..::.Boolean
true if the current instance receives a signal; otherwise, false.

Exceptions

Exception	Condition
ObjectDisposedException	The current instance has already been disposed.
ArgumentOutOfRangeException	millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.
AbandonedMutexException	The wait completed because a thread exited without releasing a mutex. This exception is not thrown on Windows 98 or Windows Millennium Edition.
InvalidOperationException	The current instance is a transparent proxy for a WaitHandle in another application domain.

Remarks

If millisecondsTimeout is zero, the method does not block. It tests the state of the wait handle and returns immediately.

The caller of this method blocks until the current instance receives a signal or a time-out occurs. Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. For more information, see the IAsyncResult interface.

Override this method to customize the behavior of derived classes.

Calling this method overload is the same as calling the WaitOne(Int32, Boolean) overload and specifying false for exitContext.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5 SP1, 3.0 SP2, 2.0 SP2

Reference

WaitHandle Class

WaitHandle Members

WaitOne Overload

System.Threading Namespace

Change History

Date	History	Reason
July 2008	Added topic for new overload.	SP1 feature change.

Date

History

Reason

July 2008

Added topic for new overload.

SP1 feature change.