WaitHandle.WaitOne Method ()
Blocks the current thread until the current WaitHandle receives a signal.
Assembly: mscorlib (in mscorlib.dll)
| Exception | Condition |
|---|---|
| ObjectDisposedException | The current instance has already been disposed. |
| 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. |
AbandonedMutexException is new in the .NET Framework version 2.0. In previous versions, the WaitOne method returns true when a mutex is abandoned. An abandoned mutex often indicates a serious coding error. In the case of a system-wide mutex, it might indicate that an application has been terminated abruptly (for example, by using Windows Task Manager). The exception contains information useful for debugging.
The caller of this method blocks indefinitely until the current instance receives a signal. 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.
Calling this method overload is equivalent to calling the WaitOne(Int32, Boolean) method overload and specifying -1 or Timeout.Infinite for the first parameter and false for the second parameter.
Override this method to customize the behavior of derived classes.
The following code example shows how to use a wait handle to keep a process from terminating while it waits for a background thread to finish executing.
Imports System Imports System.Threading Public Class WaitOne Shared autoEvent As New AutoResetEvent(False) <MTAThread> _ Shared Sub Main() Console.WriteLine("Main starting.") ThreadPool.QueueUserWorkItem(AddressOf WorkMethod, autoEvent) ' Wait for work method to signal. autoEvent.WaitOne() Console.WriteLine("Work method signaled.") Console.WriteLine("Main ending.") End Sub Shared Sub WorkMethod(stateInfo As Object) Console.WriteLine("Work starting.") ' Simulate time spent working. Thread.Sleep(New Random().Next(100, 2000)) ' Signal that work is finished. Console.WriteLine("Work ending.") CType(stateInfo, AutoResetEvent).Set() End Sub End Class
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1