WaitHandle.WaitOne 方法

定義

封鎖目前的執行緒,直到目前的 WaitHandle 收到訊號為止。Blocks the current thread until the current WaitHandle receives a signal.

多載

WaitOne()

封鎖目前的執行緒,直到目前的 WaitHandle 收到訊號為止。Blocks the current thread until the current WaitHandle receives a signal.

WaitOne(Int32)

封鎖目前執行緒,直到目前的 WaitHandle 收到信號為止,使用 32 位元帶正負號的整數來指定時間間隔 (以毫秒為單位)。Blocks the current thread until the current WaitHandle receives a signal, using a 32-bit signed integer to specify the time interval in milliseconds.

WaitOne(TimeSpan)

封鎖目前執行緒,直到目前執行個體收到信號為止,使用 TimeSpan 來指定時間間隔。Blocks the current thread until the current instance receives a signal, using a TimeSpan to specify the time interval.

WaitOne(Int32, Boolean)

封鎖目前執行緒,直到目前的 WaitHandle 收到信號為止,使用 32 位元帶正負號的整數來指定時間間隔,並指定是否要先離開同步處理網域,再開始等候。Blocks the current thread until the current WaitHandle receives a signal, using a 32-bit signed integer to specify the time interval and specifying whether to exit the synchronization domain before the wait.

WaitOne(TimeSpan, Boolean)

封鎖目前執行緒,直到目前執行個體收到信號為止,使用 TimeSpan 來指定時間間隔,並指定是否要先離開同步處理網域,再開始等候。Blocks the current thread until the current instance receives a signal, using a TimeSpan to specify the time interval and specifying whether to exit the synchronization domain before the wait.

WaitOne()

封鎖目前的執行緒,直到目前的 WaitHandle 收到訊號為止。Blocks the current thread until the current WaitHandle receives a signal.

public:
 virtual bool WaitOne();
public virtual bool WaitOne ();
abstract member WaitOne : unit -> bool
override this.WaitOne : unit -> bool
Public Overridable Function WaitOne () As Boolean

傳回

如果目前的執行個體有收到信號,則為 truetrue if the current instance receives a signal. 如果目前的執行個體一直沒有收到訊號,WaitOne(Int32, Boolean) 就一定不會傳回。If the current instance is never signaled, WaitOne(Int32, Boolean) never returns.

例外狀況

目前的執行個體已經過處置。The current instance has already been disposed.

由於執行緒結束時未釋放 Mutex,已完成等候。The wait completed because a thread exited without releasing a mutex. 在 Windows 98 或 Windows Millennium Edition 上不擲回這個例外狀況。This exception is not thrown on Windows 98 or Windows Millennium Edition.

目前的執行個體是另一個應用程式定義域中 WaitHandle 的 Transparent Proxy。The current instance is a transparent proxy for a WaitHandle in another application domain.

範例

下列程式碼範例示範如何在等候背景執行緒完成執行時,使用等候控制碼讓進程終止。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.

using namespace System;
using namespace System::Threading;
ref class WaitOne
{
private:
   WaitOne(){}


public:
   static void WorkMethod( Object^ stateInfo )
   {
      Console::WriteLine( "Work starting." );
      
      // Simulate time spent working.
      Thread::Sleep( (gcnew Random)->Next( 100, 2000 ) );
      
      // Signal that work is finished.
      Console::WriteLine( "Work ending." );
      dynamic_cast<AutoResetEvent^>(stateInfo)->Set();
   }

};

int main()
{
   Console::WriteLine( "Main starting." );
   AutoResetEvent^ autoEvent = gcnew AutoResetEvent( false );
   ThreadPool::QueueUserWorkItem( gcnew WaitCallback( &WaitOne::WorkMethod ), autoEvent );
   
   // Wait for work method to signal.
   autoEvent->WaitOne(  );
   Console::WriteLine( "Work method signaled.\nMain ending." );
}

using System;
using System.Threading;

class WaitOne
{
    static AutoResetEvent autoEvent = new AutoResetEvent(false);

    static void Main()
    {
        Console.WriteLine("Main starting.");

        ThreadPool.QueueUserWorkItem(
            new WaitCallback(WorkMethod), autoEvent);

        // Wait for work method to signal.
        autoEvent.WaitOne();
        Console.WriteLine("Work method signaled.\nMain ending.");
    }

    static void WorkMethod(object stateInfo) 
    {
        Console.WriteLine("Work starting.");

        // Simulate time spent working.
        Thread.Sleep(new Random().Next(100, 2000));

        // Signal that work is finished.
        Console.WriteLine("Work ending.");
        ((AutoResetEvent)stateInfo).Set();
    }
}
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

備註

AbandonedMutexException 是 .NET Framework 2.0 版的新功能。AbandonedMutexException is new in the .NET Framework version 2.0. 在先前的版本中,當 mutex 被放棄時,WaitOne 方法會傳回 trueIn previous versions, the WaitOne method returns true when a mutex is abandoned. 已放棄的 mutex 通常表示發生嚴重的編碼錯誤。An abandoned mutex often indicates a serious coding error. 如果是整個系統的 mutex,可能表示應用程式突然終止(例如,使用 Windows 工作管理員)。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. 使用此方法來封鎖,直到 @no__t 0 收到來自另一個執行緒的信號,例如當非同步作業完成時產生。Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. 如需詳細資訊,請參閱 IAsyncResult 介面。For more information, see the IAsyncResult interface.

呼叫這個方法多載相當於呼叫 WaitOne(Int32, Boolean) 方法多載,並為第一個參數指定-1 或 Timeout.Infinite,並針對第二個參數 falseCalling 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.

WaitOne(Int32)

封鎖目前執行緒,直到目前的 WaitHandle 收到信號為止,使用 32 位元帶正負號的整數來指定時間間隔 (以毫秒為單位)。Blocks the current thread until the current WaitHandle receives a signal, using a 32-bit signed integer to specify the time interval in milliseconds.

public:
 virtual bool WaitOne(int millisecondsTimeout);
public virtual bool WaitOne (int millisecondsTimeout);
abstract member WaitOne : int -> bool
override this.WaitOne : int -> bool
Public Overridable Function WaitOne (millisecondsTimeout As Integer) As Boolean

參數

millisecondsTimeout
Int32

要等候的毫秒數,如果要無限期等候,則為 Infinite (-1)。The number of milliseconds to wait, or Infinite (-1) to wait indefinitely.

傳回

如果目前的執行個體收到信號,則為 true,否則為 falsetrue if the current instance receives a signal; otherwise, false.

例外狀況

目前的執行個體已經過處置。The current instance has already been disposed.

millisecondsTimeout 為 -1 以外的負數,表示無限逾時。millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.

由於執行緒結束時未釋放 Mutex,已完成等候。The wait completed because a thread exited without releasing a mutex. 在 Windows 98 或 Windows Millennium Edition 上不擲回這個例外狀況。This exception is not thrown on Windows 98 or Windows Millennium Edition.

目前的執行個體是另一個應用程式定義域中 WaitHandle 的 Transparent Proxy。The current instance is a transparent proxy for a WaitHandle in another application domain.

範例

下列程式碼範例示範如何在等候背景執行緒完成執行時,使用等候控制碼讓進程終止。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.

using namespace System;
using namespace System::Threading;
ref class WaitOne
{
private:
   WaitOne(){}


public:
   static void WorkMethod( Object^ stateInfo )
   {
      Console::WriteLine( "Work starting." );
      
      // Simulate time spent working.
      Thread::Sleep( (gcnew Random)->Next( 100, 2000 ) );
      
      // Signal that work is finished.
      Console::WriteLine( "Work ending." );
      dynamic_cast<AutoResetEvent^>(stateInfo)->Set();
   }

};

int main()
{
   Console::WriteLine( "Main starting." );
   AutoResetEvent^ autoEvent = gcnew AutoResetEvent( false );
   ThreadPool::QueueUserWorkItem( gcnew WaitCallback( &WaitOne::WorkMethod ), autoEvent );
   
   // Wait for work method to signal.
   if ( autoEvent->WaitOne( 1000 ) )
   {
      Console::WriteLine( "Work method signaled." );
   }
   else
   {
      Console::WriteLine( "Timed out waiting for work "
      "method to signal." );
   }

   Console::WriteLine( "Main ending." );
}

using System;
using System.Threading;

class WaitOne
{
    static AutoResetEvent autoEvent = new AutoResetEvent(false);

    static void Main()
    {
        Console.WriteLine("Main starting.");

        ThreadPool.QueueUserWorkItem(
            new WaitCallback(WorkMethod), autoEvent);

        // Wait for work method to signal.
        if(autoEvent.WaitOne(1000))
        {
            Console.WriteLine("Work method signaled.");
        }
        else
        {
            Console.WriteLine("Timed out waiting for work " +
                "method to signal.");
        }
        Console.WriteLine("Main ending.");
    }

    static void WorkMethod(object stateInfo) 
    {
        Console.WriteLine("Work starting.");

        // Simulate time spent working.
        Thread.Sleep(new Random().Next(100, 2000));

        // Signal that work is finished.
        Console.WriteLine("Work ending.");
        ((AutoResetEvent)stateInfo).Set();
    }
}
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.
        If autoEvent.WaitOne(1000) Then
            Console.WriteLine("Work method signaled.")
        Else
            Console.WriteLine("Timed out waiting for work " & _
                "method to signal.")
        End If

        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

備註

如果 millisecondsTimeout 為零,則方法不會封鎖。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. 使用此方法來封鎖,直到 @no__t 0 收到來自另一個執行緒的信號,例如當非同步作業完成時產生。Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. 如需詳細資訊,請參閱 IAsyncResult 介面。For more information, see the IAsyncResult interface.

覆寫這個方法,以自訂衍生類別的行為。Override this method to customize the behavior of derived classes.

呼叫這個方法多載等同于呼叫 @no__t 0 多載,並為 exitContext 指定 falseCalling this method overload is the same as calling the WaitOne(Int32, Boolean) overload and specifying false for exitContext.

WaitOne(TimeSpan)

封鎖目前執行緒,直到目前執行個體收到信號為止,使用 TimeSpan 來指定時間間隔。Blocks the current thread until the current instance receives a signal, using a TimeSpan to specify the time interval.

public:
 virtual bool WaitOne(TimeSpan timeout);
public virtual bool WaitOne (TimeSpan timeout);
abstract member WaitOne : TimeSpan -> bool
override this.WaitOne : TimeSpan -> bool
Public Overridable Function WaitOne (timeout As TimeSpan) As Boolean

參數

timeout
TimeSpan

TimeSpan,代表等候毫秒數;或是 TimeSpan,代表無限期等候的 -1 毫秒。A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.

傳回

如果目前的執行個體收到信號,則為 true,否則為 falsetrue if the current instance receives a signal; otherwise, false.

例外狀況

目前的執行個體已經過處置。The current instance has already been disposed.

timeout 為 -1 毫秒以外的負數,表示無限逾時。timeout is a negative number other than -1 milliseconds, which represents an infinite time-out. -或--or- timeout 大於 MaxValuetimeout is greater than MaxValue.

由於執行緒結束時未釋放 Mutex,已完成等候。The wait completed because a thread exited without releasing a mutex. 在 Windows 98 或 Windows Millennium Edition 上不擲回這個例外狀況。This exception is not thrown on Windows 98 or Windows Millennium Edition.

目前的執行個體是另一個應用程式定義域中 WaitHandle 的 Transparent Proxy。The current instance is a transparent proxy for a WaitHandle in another application domain.

備註

如果 timeout 為零,則方法不會封鎖。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. 使用此方法來封鎖,直到 @no__t 0 收到來自另一個執行緒的信號,例如當非同步作業完成時產生。Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. 如需詳細資訊,請參閱 IAsyncResult 介面。For more information, see the IAsyncResult interface.

覆寫這個方法,以自訂衍生類別的行為。Override this method to customize the behavior of derived classes.

@No__t-0 的最大值為 Int32.MaxValueThe maximum value for timeout is Int32.MaxValue.

呼叫這個方法多載等同于呼叫 @no__t 0 多載,並為 exitContext 指定 falseCalling this method overload is the same as calling the WaitOne(TimeSpan, Boolean) overload and specifying false for exitContext.

WaitOne(Int32, Boolean)

封鎖目前執行緒,直到目前的 WaitHandle 收到信號為止,使用 32 位元帶正負號的整數來指定時間間隔,並指定是否要先離開同步處理網域,再開始等候。Blocks the current thread until the current WaitHandle receives a signal, using a 32-bit signed integer to specify the time interval and specifying whether to exit the synchronization domain before the wait.

public:
 virtual bool WaitOne(int millisecondsTimeout, bool exitContext);
public virtual bool WaitOne (int millisecondsTimeout, bool exitContext);
abstract member WaitOne : int * bool -> bool
override this.WaitOne : int * bool -> bool
Public Overridable Function WaitOne (millisecondsTimeout As Integer, exitContext As Boolean) As Boolean

參數

millisecondsTimeout
Int32

要等候的毫秒數,如果要無限期等候,則為 Infinite (-1)。The number of milliseconds to wait, or Infinite (-1) to wait indefinitely.

exitContext
Boolean

true 表示在等候 (如果在同步內容中) 前結束內容的同步處理網域,並於之後重新取得,否則為 falsetrue to exit the synchronization domain for the context before the wait (if in a synchronized context), and reacquire it afterward; otherwise, false.

傳回

如果目前的執行個體收到信號,則為 true,否則為 falsetrue if the current instance receives a signal; otherwise, false.

例外狀況

目前的執行個體已經過處置。The current instance has already been disposed.

millisecondsTimeout 為 -1 以外的負數,表示無限逾時。millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.

由於執行緒結束時未釋放 Mutex,已完成等候。The wait completed because a thread exited without releasing a mutex. 在 Windows 98 或 Windows Millennium Edition 上不擲回這個例外狀況。This exception is not thrown on Windows 98 or Windows Millennium Edition.

目前的執行個體是另一個應用程式定義域中 WaitHandle 的 Transparent Proxy。The current instance is a transparent proxy for a WaitHandle in another application domain.

範例

下列範例顯示在同步處理網域內呼叫 WaitOne(Int32, Boolean) 方法多載的行為。The following example shows how the WaitOne(Int32, Boolean) method overload behaves when it is called within a synchronization domain. 首先,執行緒會等待 exitContext 設定為 false 並封鎖,直到等候超時時間到期為止。First, a thread waits with exitContext set to false and blocks until the wait timeout expires. 第二個執行緒會在第一個執行緒終止之後執行,並等候 exitContext 設定為 trueA second thread executes after the first thread terminates and waits with exitContext set to true. 對這個第二個執行緒等候控制碼發出信號的呼叫不會被封鎖,而且執行緒會在等候超時之前完成。The call to signal the wait handle for this second thread is not blocked, and the thread completes before the wait timeout.

using namespace System;
using namespace System::Threading;
using namespace System::Runtime::Remoting::Contexts;

[Synchronization(true)]
public ref class SyncingClass : ContextBoundObject
{
private:
    EventWaitHandle^ waitHandle;

public:
    SyncingClass()
    {
         waitHandle =
            gcnew EventWaitHandle(false, EventResetMode::ManualReset);
    }

    void Signal()
    {
        Console::WriteLine("Thread[{0:d4}]: Signalling...", Thread::CurrentThread->GetHashCode());
        waitHandle->Set();
    }

    void DoWait(bool leaveContext)
    {
        bool signalled;

        waitHandle->Reset();
        Console::WriteLine("Thread[{0:d4}]: Waiting...", Thread::CurrentThread->GetHashCode());
        signalled = waitHandle->WaitOne(3000, leaveContext);
        if (signalled)
        {
            Console::WriteLine("Thread[{0:d4}]: Wait released!!!", Thread::CurrentThread->GetHashCode());
        }
        else
        {
            Console::WriteLine("Thread[{0:d4}]: Wait timeout!!!", Thread::CurrentThread->GetHashCode());
        }
    }
};

public ref class TestSyncDomainWait
{
public:
    static void Main()
    {
        SyncingClass^ syncClass = gcnew SyncingClass();

        Thread^ runWaiter;

        Console::WriteLine("\nWait and signal INSIDE synchronization domain:\n");
        runWaiter = gcnew Thread(gcnew ParameterizedThreadStart(&TestSyncDomainWait::RunWaitKeepContext));
        runWaiter->Start(syncClass);
        Thread::Sleep(1000);
        Console::WriteLine("Thread[{0:d4}]: Signal...", Thread::CurrentThread->GetHashCode());
        // This call to Signal will block until the timeout in DoWait expires.
        syncClass->Signal();
        runWaiter->Join();

        Console::WriteLine("\nWait and signal OUTSIDE synchronization domain:\n");
        runWaiter = gcnew Thread(gcnew ParameterizedThreadStart(&TestSyncDomainWait::RunWaitLeaveContext));
        runWaiter->Start(syncClass);
        Thread::Sleep(1000);
        Console::WriteLine("Thread[{0:d4}]: Signal...", Thread::CurrentThread->GetHashCode());
        // This call to Signal is unblocked and will set the wait handle to
        // release the waiting thread.
        syncClass->Signal();
        runWaiter->Join();
    }

    static void RunWaitKeepContext(Object^ parm)
    {
        ((SyncingClass^)parm)->DoWait(false);
    }

    static void RunWaitLeaveContext(Object^ parm)
    {
        ((SyncingClass^)parm)->DoWait(true);
    }
};

int main()
{
    TestSyncDomainWait::Main();
}
// The output for the example program will be similar to the following:
//
// Wait and signal INSIDE synchronization domain:
//
// Thread[0004]: Waiting...
// Thread[0001]: Signal...
// Thread[0004]: Wait timeout!!!
// Thread[0001]: Signalling...
//
// Wait and signal OUTSIDE synchronization domain:
//
// Thread[0006]: Waiting...
// Thread[0001]: Signal...
// Thread[0001]: Signalling...
// Thread[0006]: Wait released!!!
using System;
using System.Threading;
using System.Runtime.Remoting.Contexts;

[Synchronization(true)]
public class SyncingClass : ContextBoundObject
{
    private EventWaitHandle waitHandle;

    public SyncingClass()
    {
         waitHandle =
            new EventWaitHandle(false, EventResetMode.ManualReset);
    }

    public void Signal()
    {
        Console.WriteLine("Thread[{0:d4}]: Signalling...", Thread.CurrentThread.GetHashCode());
        waitHandle.Set();
    }

    public void DoWait(bool leaveContext)
    {
        bool signalled;

        waitHandle.Reset();
        Console.WriteLine("Thread[{0:d4}]: Waiting...", Thread.CurrentThread.GetHashCode());
        signalled = waitHandle.WaitOne(3000, leaveContext);
        if (signalled)
        {
            Console.WriteLine("Thread[{0:d4}]: Wait released!!!", Thread.CurrentThread.GetHashCode());
        }
        else
        {
            Console.WriteLine("Thread[{0:d4}]: Wait timeout!!!", Thread.CurrentThread.GetHashCode());
        }
    }
}

public class TestSyncDomainWait
{
    public static void Main()
    {
        SyncingClass syncClass = new SyncingClass();

        Thread runWaiter;

        Console.WriteLine("\nWait and signal INSIDE synchronization domain:\n");
        runWaiter = new Thread(RunWaitKeepContext);
        runWaiter.Start(syncClass);
        Thread.Sleep(1000);
        Console.WriteLine("Thread[{0:d4}]: Signal...", Thread.CurrentThread.GetHashCode());
        // This call to Signal will block until the timeout in DoWait expires.
        syncClass.Signal();
        runWaiter.Join();

        Console.WriteLine("\nWait and signal OUTSIDE synchronization domain:\n");
        runWaiter = new Thread(RunWaitLeaveContext);
        runWaiter.Start(syncClass);
        Thread.Sleep(1000);
        Console.WriteLine("Thread[{0:d4}]: Signal...", Thread.CurrentThread.GetHashCode());
        // This call to Signal is unblocked and will set the wait handle to
        // release the waiting thread.
        syncClass.Signal();
        runWaiter.Join();
    }

    public static void RunWaitKeepContext(object parm)
    {
        ((SyncingClass)parm).DoWait(false);
    }

    public static void RunWaitLeaveContext(object parm)
    {
        ((SyncingClass)parm).DoWait(true);
    }
}

// The output for the example program will be similar to the following:
//
// Wait and signal INSIDE synchronization domain:
//
// Thread[0004]: Waiting...
// Thread[0001]: Signal...
// Thread[0004]: Wait timeout!!!
// Thread[0001]: Signalling...
//
// Wait and signal OUTSIDE synchronization domain:
//
// Thread[0006]: Waiting...
// Thread[0001]: Signal...
// Thread[0001]: Signalling...
// Thread[0006]: Wait released!!!
Imports System.Threading
Imports System.Runtime.Remoting.Contexts

<Synchronization(true)>
Public Class SyncingClass
    Inherits ContextBoundObject
    
    Private waitHandle As EventWaitHandle

    Public Sub New()
         waitHandle = New EventWaitHandle(false, EventResetMode.ManualReset)
    End Sub

    Public Sub Signal()
        Console.WriteLine("Thread[{0:d4}]: Signalling...", Thread.CurrentThread.GetHashCode())
        waitHandle.Set()
    End Sub

    Public Sub DoWait(leaveContext As Boolean)
        Dim signalled As Boolean

        waitHandle.Reset()
        Console.WriteLine("Thread[{0:d4}]: Waiting...", Thread.CurrentThread.GetHashCode())
        signalled = waitHandle.WaitOne(3000, leaveContext)
        If signalled Then
            Console.WriteLine("Thread[{0:d4}]: Wait released!!!", Thread.CurrentThread.GetHashCode())
        Else
            Console.WriteLine("Thread[{0:d4}]: Wait timeout!!!", Thread.CurrentThread.GetHashCode())
        End If
    End Sub
End Class

Public Class TestSyncDomainWait
    Public Shared Sub Main()
        Dim syncClass As New SyncingClass()

        Dim runWaiter As Thread

        Console.WriteLine(vbNewLine + "Wait and signal INSIDE synchronization domain:" + vbNewLine)
        runWaiter = New Thread(AddressOf RunWaitKeepContext)
        runWaiter.Start(syncClass)
        Thread.Sleep(1000)
        Console.WriteLine("Thread[{0:d4}]: Signal...", Thread.CurrentThread.GetHashCode())
        ' This call to Signal will block until the timeout in DoWait expires.
        syncClass.Signal()
        runWaiter.Join()

        Console.WriteLine(vbNewLine + "Wait and signal OUTSIDE synchronization domain:" + vbNewLine)
        runWaiter = New Thread(AddressOf RunWaitLeaveContext)
        runWaiter.Start(syncClass)
        Thread.Sleep(1000)
        Console.WriteLine("Thread[{0:d4}]: Signal...", Thread.CurrentThread.GetHashCode())
        ' This call to Signal is unblocked and will set the wait handle to
        ' release the waiting thread.
        syncClass.Signal()
        runWaiter.Join()
    End Sub

    Public Shared Sub RunWaitKeepContext(parm As Object)
        Dim syncClass As SyncingClass = CType(parm, SyncingClass)
        syncClass.DoWait(False)
    End Sub

    Public Shared Sub RunWaitLeaveContext(parm As Object)
        Dim syncClass As SyncingClass = CType(parm, SyncingClass)
        syncClass.DoWait(True)
    End Sub
End Class

' The output for the example program will be similar to the following:
'
' Wait and signal INSIDE synchronization domain:
'
' Thread[0004]: Waiting...
' Thread[0001]: Signal...
' Thread[0004]: Wait timeout!!!
' Thread[0001]: Signalling...
'
' Wait and signal OUTSIDE synchronization domain:
'
' Thread[0006]: Waiting...
' Thread[0001]: Signal...
' Thread[0001]: Signalling...
' Thread[0006]: Wait released!!!

備註

如果 millisecondsTimeout 為零,則方法不會封鎖。If millisecondsTimeout is zero, the method does not block. 它會測試等候控制碼的狀態並立即傳回。It tests the state of the wait handle and returns immediately.

AbandonedMutexException 是 .NET Framework 2.0 版的新功能。AbandonedMutexException is new in the .NET Framework version 2.0. 在先前的版本中,當 mutex 被放棄時,WaitOne 方法會傳回 trueIn previous versions, the WaitOne method returns true when a mutex is abandoned. 已放棄的 mutex 通常表示發生嚴重的編碼錯誤。An abandoned mutex often indicates a serious coding error. 如果是整個系統的 mutex,可能表示應用程式突然終止(例如,使用 Windows 工作管理員)。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 until the current instance receives a signal or a time-out occurs. 使用此方法來封鎖,直到 @no__t 0 收到來自另一個執行緒的信號,例如當非同步作業完成時產生。Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. 如需詳細資訊,請參閱 IAsyncResult 介面。For more information, see the IAsyncResult interface.

覆寫這個方法,以自訂衍生類別的行為。Override this method to customize the behavior of derived classes.

結束內容時的注意事項Notes on Exiting the Context

除非從非預設的 managed 內容中呼叫 WaitOne 方法,否則 exitContext 參數不會有任何作用。The exitContext parameter has no effect unless the WaitOne method is called from inside a nondefault managed context. 如果您的執行緒位於衍生自 ContextBoundObject 之類別的實例內,就會發生這種情況。This can happen if your thread is inside a call to an instance of a class derived from ContextBoundObject. 即使您目前在不是從 ContextBoundObject 衍生的類別上執行方法(例如 String),如果 ContextBoundObject 位於目前應用程式域中的堆疊上,您可以在非預設的內容中。Even if you are currently executing a method on a class that does not derive from ContextBoundObject, like String, you can be in a nondefault context if a ContextBoundObject is on your stack in the current application domain.

當您的程式碼在非預設的內容中執行時,為 exitContext 指定 true,會導致執行緒在執行 WaitOne 方法之前結束非預設的 managed 內容(也就是轉換成預設內容)。When your code is executing in a nondefault context, specifying true for exitContext causes the thread to exit the nondefault managed context (that is, to transition to the default context) before executing the WaitOne method. WaitOne 方法的呼叫完成後,執行緒會回到原始的非預設內容。The thread returns to the original nondefault context after the call to the WaitOne method completes.

當內容系結的類別具有 SynchronizationAttribute 時,這會很有用。This can be useful when the context-bound class has SynchronizationAttribute. 在此情況下,所有對類別成員的呼叫都會自動同步處理,而同步處理網域是類別的整個程式碼主體。In that case, all calls to members of the class are automatically synchronized, and the synchronization domain is the entire body of code for the class. 如果成員呼叫堆疊中的程式碼會呼叫 WaitOne 方法,並為 exitContext 指定 true,則執行緒會結束同步處理網域,允許在對物件的任何成員呼叫封鎖的執行緒繼續進行。If code in the call stack of a member calls the WaitOne method and specifies true for exitContext, the thread exits the synchronization domain, allowing a thread that is blocked on a call to any member of the object to proceed. WaitOne 方法傳回時,進行呼叫的執行緒必須等待重新輸入同步處理網域。When the WaitOne method returns, the thread that made the call must wait to reenter the synchronization domain.

WaitOne(TimeSpan, Boolean)

封鎖目前執行緒,直到目前執行個體收到信號為止,使用 TimeSpan 來指定時間間隔,並指定是否要先離開同步處理網域,再開始等候。Blocks the current thread until the current instance receives a signal, using a TimeSpan to specify the time interval and specifying whether to exit the synchronization domain before the wait.

public:
 virtual bool WaitOne(TimeSpan timeout, bool exitContext);
public virtual bool WaitOne (TimeSpan timeout, bool exitContext);
abstract member WaitOne : TimeSpan * bool -> bool
override this.WaitOne : TimeSpan * bool -> bool
Public Overridable Function WaitOne (timeout As TimeSpan, exitContext As Boolean) As Boolean

參數

timeout
TimeSpan

TimeSpan,代表等候毫秒數;或是 TimeSpan,代表無限期等候的 -1 毫秒。A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.

exitContext
Boolean

true 表示在等候 (如果在同步內容中) 前結束內容的同步處理網域,並於之後重新取得,否則為 falsetrue to exit the synchronization domain for the context before the wait (if in a synchronized context), and reacquire it afterward; otherwise, false.

傳回

如果目前的執行個體收到信號,則為 true,否則為 falsetrue if the current instance receives a signal; otherwise, false.

例外狀況

目前的執行個體已經過處置。The current instance has already been disposed.

timeout 為 -1 毫秒以外的負數,表示無限逾時。timeout is a negative number other than -1 milliseconds, which represents an infinite time-out. -或--or- timeout 大於 MaxValuetimeout is greater than MaxValue.

由於執行緒結束時未釋放 Mutex,已完成等候。The wait completed because a thread exited without releasing a mutex. 在 Windows 98 或 Windows Millennium Edition 上不擲回這個例外狀況。This exception is not thrown on Windows 98 or Windows Millennium Edition.

目前的執行個體是另一個應用程式定義域中 WaitHandle 的 Transparent Proxy。The current instance is a transparent proxy for a WaitHandle in another application domain.

範例

下列程式碼範例示範如何在等候背景執行緒完成執行時,使用等候控制碼讓進程終止。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.

using namespace System;
using namespace System::Threading;
ref class WaitOne
{
private:
   WaitOne(){}


public:
   static void WorkMethod( Object^ stateInfo )
   {
      Console::WriteLine( "Work starting." );
      
      // Simulate time spent working.
      Thread::Sleep( (gcnew Random)->Next( 100, 2000 ) );
      
      // Signal that work is finished.
      Console::WriteLine( "Work ending." );
      dynamic_cast<AutoResetEvent^>(stateInfo)->Set();
   }

};

int main()
{
   Console::WriteLine( "Main starting." );
   AutoResetEvent^ autoEvent = gcnew AutoResetEvent( false );
   ThreadPool::QueueUserWorkItem( gcnew WaitCallback( &WaitOne::WorkMethod ), autoEvent );
   
   // Wait for work method to signal.
   if ( autoEvent->WaitOne( TimeSpan(0,0,1), false ) )
   {
      Console::WriteLine( "Work method signaled." );
   }
   else
   {
      Console::WriteLine( "Timed out waiting for work "
      "method to signal." );
   }

   Console::WriteLine( "Main ending." );
}

using System;
using System.Threading;

class WaitOne
{
    static AutoResetEvent autoEvent = new AutoResetEvent(false);

    static void Main()
    {
        Console.WriteLine("Main starting.");

        ThreadPool.QueueUserWorkItem(
            new WaitCallback(WorkMethod), autoEvent);

        // Wait for work method to signal.
        if(autoEvent.WaitOne(new TimeSpan(0, 0, 1), false))
        {
            Console.WriteLine("Work method signaled.");
        }
        else
        {
            Console.WriteLine("Timed out waiting for work " +
                "method to signal.");
        }
        Console.WriteLine("Main ending.");
    }

    static void WorkMethod(object stateInfo) 
    {
        Console.WriteLine("Work starting.");

        // Simulate time spent working.
        Thread.Sleep(new Random().Next(100, 2000));

        // Signal that work is finished.
        Console.WriteLine("Work ending.");
        ((AutoResetEvent)stateInfo).Set();
    }
}
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.
        If autoEvent.WaitOne(New TimeSpan(0, 0, 1), False) Then
            Console.WriteLine("Work method signaled.")
        Else
            Console.WriteLine("Timed out waiting for work " & _
                "method to signal.")
        End If

        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

備註

如果 timeout 為零,則方法不會封鎖。If timeout is zero, the method does not block. 它會測試等候控制碼的狀態並立即傳回。It tests the state of the wait handle and returns immediately.

AbandonedMutexException 是 .NET Framework 2.0 版的新功能。AbandonedMutexException is new in the .NET Framework version 2.0. 在先前的版本中,當 mutex 被放棄時,WaitOne 方法會傳回 trueIn previous versions, the WaitOne method returns true when a mutex is abandoned. 已放棄的 mutex 通常表示發生嚴重的編碼錯誤。An abandoned mutex often indicates a serious coding error. 如果是整個系統的 mutex,可能表示應用程式突然終止(例如,使用 Windows 工作管理員)。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 until the current instance receives a signal or a time-out occurs. 使用此方法來封鎖,直到 @no__t 0 收到來自另一個執行緒的信號,例如當非同步作業完成時產生。Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. 如需詳細資訊,請參閱 IAsyncResult 介面。For more information, see the IAsyncResult interface.

覆寫這個方法,以自訂衍生類別的行為。Override this method to customize the behavior of derived classes.

@No__t-0 的最大值為 Int32.MaxValueThe maximum value for timeout is Int32.MaxValue.

結束內容時的注意事項Notes on Exiting the Context

除非從非預設的 managed 內容中呼叫 WaitOne 方法,否則 exitContext 參數不會有任何作用。The exitContext parameter has no effect unless the WaitOne method is called from inside a nondefault managed context. 如果您的執行緒位於衍生自 ContextBoundObject 之類別的實例內,就會發生這種情況。This can happen if your thread is inside a call to an instance of a class derived from ContextBoundObject. 即使您目前在不是從 ContextBoundObject 衍生的類別上執行方法(例如 String),如果 ContextBoundObject 位於目前應用程式域中的堆疊上,您可以在非預設的內容中。Even if you are currently executing a method on a class that does not derive from ContextBoundObject, like String, you can be in a nondefault context if a ContextBoundObject is on your stack in the current application domain.

當您的程式碼在非預設的內容中執行時,為 exitContext 指定 true,會導致執行緒在執行 WaitOne 方法之前結束非預設的 managed 內容(也就是轉換成預設內容)。When your code is executing in a nondefault context, specifying true for exitContext causes the thread to exit the nondefault managed context (that is, to transition to the default context) before executing the WaitOne method. WaitOne 方法的呼叫完成後,執行緒會回到原始的非預設內容。The thread returns to the original nondefault context after the call to the WaitOne method completes.

當內容系結的類別具有 SynchronizationAttribute 時,這會很有用。This can be useful when the context-bound class has SynchronizationAttribute. 在此情況下,所有對類別成員的呼叫都會自動同步處理,而同步處理網域是類別的整個程式碼主體。In that case, all calls to members of the class are automatically synchronized, and the synchronization domain is the entire body of code for the class. 如果成員呼叫堆疊中的程式碼會呼叫 WaitOne 方法,並為 exitContext 指定 true,則執行緒會結束同步處理網域,允許在對物件的任何成員呼叫封鎖的執行緒繼續進行。If code in the call stack of a member calls the WaitOne method and specifies true for exitContext, the thread exits the synchronization domain, allowing a thread that is blocked on a call to any member of the object to proceed. WaitOne 方法傳回時,進行呼叫的執行緒必須等待重新輸入同步處理網域。When the WaitOne method returns, the thread that made the call must wait to reenter the synchronization domain.

適用於