WaitHandle.WaitOne Method (TimeSpan)
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Blocks the current thread until the current instance receives a signal, using a TimeSpan to specify the time interval.
Namespace: System.Threading
Assembly: mscorlib (in mscorlib.dll)
Syntax
'Declaration
Public Overridable Function WaitOne ( _
timeout As TimeSpan _
) As Boolean
public virtual bool WaitOne(
TimeSpan timeout
)
Parameters
- timeout
Type: System.TimeSpan
A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds 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 | timeout is a negative number other than -1 milliseconds, which represents an infinite time-out. -or- timeout is greater than Int32.MaxValue. |
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 WaitHandle receives a signal from another thread, such as the signal that 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 Int32.MaxValue.
Version Information
Silverlight
Supported in: 5, 4, 3
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0
XNA Framework
Supported in: Xbox 360, Windows Phone OS 7.0
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.