System.Threading.WaitHandle.WaitOne Method

Blocks the current thread until the current instance receives a signal, using a TimeSpan to specify the time interval.

Syntax

public virtual bool WaitOne (TimeSpan timeout)

Parameters

timeout
A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.

Returns

true if the current instance receives a signal; otherwise, false.

Remarks

If timeout 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 System.Threading.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.

The maximum value for timeout is int.MaxValue.

Calling this method overload is the same as calling the WaitHandle.WaitOne(TimeSpan, bool) overload and specifying false for exitContext.

Requirements

Namespace: System.Threading
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 2.0.0.0, 4.0.0.0