WaitHandle.WaitAny 方法

定義

等候指定陣列中有任何項目收到信號。Waits for any of the elements in the specified array to receive a signal.

多載

WaitAny(WaitHandle[])

等候指定陣列中有任何項目收到信號。Waits for any of the elements in the specified array to receive a signal.

WaitAny(WaitHandle[], Int32)

等候指定之陣列中有任何項目收到信號,使用 32 位元帶正負號的整數以指定時間間隔。Waits for any of the elements in the specified array to receive a signal, using a 32-bit signed integer to specify the time interval.

WaitAny(WaitHandle[], TimeSpan)

等候指定陣列中的所有項目都收到信號,使用 TimeSpan 來指定時間間隔。Waits for any of the elements in the specified array to receive a signal, using a TimeSpan to specify the time interval.

WaitAny(WaitHandle[], Int32, Boolean)

等候指定陣列中有任何項目收到信號;使用 32 位元帶正負號的整數 (Signed Integer) 來指定時間間隔,並指定是否在等候之前先離開同步處理領域。Waits for any of the elements in the specified array to receive a signal, using a 32-bit signed integer to specify the time interval, and specifying whether to exit the synchronization domain before the wait.

WaitAny(WaitHandle[], TimeSpan, Boolean)

等候指定陣列中的所有項目都收到信號,使用 TimeSpan 來指定時間間隔,並指定是否要先離開同步處理網域,再開始等候。Waits for any of the elements in the specified array to receive a signal, using a TimeSpan to specify the time interval and specifying whether to exit the synchronization domain before the wait.

WaitAny(WaitHandle[])

等候指定陣列中有任何項目收到信號。Waits for any of the elements in the specified array to receive a signal.

public:
 static int WaitAny(cli::array <System::Threading::WaitHandle ^> ^ waitHandles);
public static int WaitAny (System.Threading.WaitHandle[] waitHandles);
static member WaitAny : System.Threading.WaitHandle[] -> int
Public Shared Function WaitAny (waitHandles As WaitHandle()) As Integer

參數

waitHandles
WaitHandle[]

WaitHandle 陣列,包含目前執行個體將等候的物件。A WaitHandle array containing the objects for which the current instance will wait.

傳回

滿足等候條件之物件的陣列索引。The array index of the object that satisfied the wait.

例外狀況

waitHandles 參數是 nullThe waitHandles parameter is null.

-或--or- waitHandles 陣列中的一或多個物件為 nullOne or more of the objects in the waitHandles array is null.

waitHandles 中的物件數目超過系統允許的數目。The number of objects in waitHandles is greater than the system permits.

waitHandles 是不具有項目的陣列,且 .NET Framework 版本為 1.0 或 1.1。waitHandles is an array with no elements, and the .NET Framework version is 1.0 or 1.1.

由於執行緒結束時未釋放 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.

waitHandles 是不具有元素的陣列,且 .NET Framework 版本為 2.0 (含) 以後版本。waitHandles is an array with no elements, and the .NET Framework version is 2.0 or later.

waitHandles 陣列在另一個應用程式定義域中包含 WaitHandle 的 Transparent Proxy。The waitHandles array contains a transparent proxy for a WaitHandle in another application domain.

範例

下列程式碼範例將示範如何呼叫 WaitAny 方法。The following code example demonstrates calling the WaitAny method.

using namespace System;
using namespace System::Threading;

public ref class WaitHandleExample
{
    // Define a random number generator for testing.
private:
    static Random^ random = gcnew Random();
public:
    static void DoTask(Object^ state)
    {
        AutoResetEvent^ autoReset = (AutoResetEvent^) state;
        int time = 1000 * random->Next(2, 10);
        Console::WriteLine("Performing a task for {0} milliseconds.", time);
        Thread::Sleep(time);
        autoReset->Set();
    }
};

int main()
{
    // Define an array with two AutoResetEvent WaitHandles.
    array<WaitHandle^>^ handles = gcnew array<WaitHandle^> {
        gcnew AutoResetEvent(false), gcnew AutoResetEvent(false)};

    // Queue up two tasks on two different threads;
    // wait until all tasks are completed.
    DateTime timeInstance = DateTime::Now;
    Console::WriteLine("Main thread is waiting for BOTH tasks to " +
        "complete.");
    ThreadPool::QueueUserWorkItem(
        gcnew WaitCallback(WaitHandleExample::DoTask), handles[0]);
    ThreadPool::QueueUserWorkItem(
        gcnew WaitCallback(WaitHandleExample::DoTask), handles[1]);
    WaitHandle::WaitAll(handles);
    // The time shown below should match the longest task.
    Console::WriteLine("Both tasks are completed (time waited={0})",
        (DateTime::Now - timeInstance).TotalMilliseconds);

    // Queue up two tasks on two different threads;
    // wait until any tasks are completed.
    timeInstance = DateTime::Now;
    Console::WriteLine();
    Console::WriteLine("The main thread is waiting for either task to " +
        "complete.");
    ThreadPool::QueueUserWorkItem(
        gcnew WaitCallback(WaitHandleExample::DoTask), handles[0]);
    ThreadPool::QueueUserWorkItem(
        gcnew WaitCallback(WaitHandleExample::DoTask), handles[1]);
    int index = WaitHandle::WaitAny(handles);
    // The time shown below should match the shortest task.
    Console::WriteLine("Task {0} finished first (time waited={1}).",
        index + 1, (DateTime::Now - timeInstance).TotalMilliseconds);
}

// This code produces the following sample output.
//
// Main thread is waiting for BOTH tasks to complete.
// Performing a task for 7000 milliseconds.
// Performing a task for 4000 milliseconds.
// Both tasks are completed (time waited=7064.8052)

// The main thread is waiting for either task to complete.
// Performing a task for 2000 milliseconds.
// Performing a task for 2000 milliseconds.
// Task 1 finished first (time waited=2000.6528).
using System;
using System.Threading;

public sealed class App 
{
    // Define an array with two AutoResetEvent WaitHandles.
    static WaitHandle[] waitHandles = new WaitHandle[] 
    {
        new AutoResetEvent(false),
        new AutoResetEvent(false)
    };

    // Define a random number generator for testing.
    static Random r = new Random();

    static void Main() 
    {
        // Queue up two tasks on two different threads; 
        // wait until all tasks are completed.
        DateTime dt = DateTime.Now;
        Console.WriteLine("Main thread is waiting for BOTH tasks to complete.");
        ThreadPool.QueueUserWorkItem(new WaitCallback(DoTask), waitHandles[0]);
        ThreadPool.QueueUserWorkItem(new WaitCallback(DoTask), waitHandles[1]);
        WaitHandle.WaitAll(waitHandles);
        // The time shown below should match the longest task.
        Console.WriteLine("Both tasks are completed (time waited={0})", 
            (DateTime.Now - dt).TotalMilliseconds);

        // Queue up two tasks on two different threads; 
        // wait until any tasks are completed.
        dt = DateTime.Now;
        Console.WriteLine();
        Console.WriteLine("The main thread is waiting for either task to complete.");
        ThreadPool.QueueUserWorkItem(new WaitCallback(DoTask), waitHandles[0]);
        ThreadPool.QueueUserWorkItem(new WaitCallback(DoTask), waitHandles[1]);
        int index = WaitHandle.WaitAny(waitHandles);
        // The time shown below should match the shortest task.
        Console.WriteLine("Task {0} finished first (time waited={1}).",
            index + 1, (DateTime.Now - dt).TotalMilliseconds);
    }

    static void DoTask(Object state) 
    {
        AutoResetEvent are = (AutoResetEvent) state;
        int time = 1000 * r.Next(2, 10);
        Console.WriteLine("Performing a task for {0} milliseconds.", time);
        Thread.Sleep(time);
        are.Set();
    }
}

// This code produces output similar to the following:
//
//  Main thread is waiting for BOTH tasks to complete.
//  Performing a task for 7000 milliseconds.
//  Performing a task for 4000 milliseconds.
//  Both tasks are completed (time waited=7064.8052)
// 
//  The main thread is waiting for either task to complete.
//  Performing a task for 2000 milliseconds.
//  Performing a task for 2000 milliseconds.
//  Task 1 finished first (time waited=2000.6528).
Imports System.Threading

NotInheritable Public Class App
    ' Define an array with two AutoResetEvent WaitHandles.
    Private Shared waitHandles() As WaitHandle = _
        {New AutoResetEvent(False), New AutoResetEvent(False)}
    
    ' Define a random number generator for testing.
    Private Shared r As New Random()
    
    <MTAThreadAttribute> _
    Public Shared Sub Main() 
        ' Queue two tasks on two different threads; 
        ' wait until all tasks are completed.
        Dim dt As DateTime = DateTime.Now
        Console.WriteLine("Main thread is waiting for BOTH tasks to complete.")
        ThreadPool.QueueUserWorkItem(AddressOf DoTask, waitHandles(0))
        ThreadPool.QueueUserWorkItem(AddressOf DoTask, waitHandles(1))
        WaitHandle.WaitAll(waitHandles)
        ' The time shown below should match the longest task.
        Console.WriteLine("Both tasks are completed (time waited={0})", _
            (DateTime.Now - dt).TotalMilliseconds)
        
        ' Queue up two tasks on two different threads; 
        ' wait until any tasks are completed.
        dt = DateTime.Now
        Console.WriteLine()
        Console.WriteLine("The main thread is waiting for either task to complete.")
        ThreadPool.QueueUserWorkItem(AddressOf DoTask, waitHandles(0))
        ThreadPool.QueueUserWorkItem(AddressOf DoTask, waitHandles(1))
        Dim index As Integer = WaitHandle.WaitAny(waitHandles)
        ' The time shown below should match the shortest task.
        Console.WriteLine("Task {0} finished first (time waited={1}).", _
            index + 1,(DateTime.Now - dt).TotalMilliseconds)
    
    End Sub
    
    Shared Sub DoTask(ByVal state As [Object]) 
        Dim are As AutoResetEvent = CType(state, AutoResetEvent)
        Dim time As Integer = 1000 * r.Next(2, 10)
        Console.WriteLine("Performing a task for {0} milliseconds.", time)
        Thread.Sleep(time)
        are.Set()
    
    End Sub
End Class

' This code produces output similar to the following:
'
'  Main thread is waiting for BOTH tasks to complete.
'  Performing a task for 7000 milliseconds.
'  Performing a task for 4000 milliseconds.
'  Both tasks are completed (time waited=7064.8052)
' 
'  The main thread is waiting for either task to complete.
'  Performing a task for 2000 milliseconds.
'  Performing a task for 2000 milliseconds.
'  Task 1 finished first (time waited=2000.6528).

備註

AbandonedMutexException 是 .NET Framework 2.0 版的新功能。AbandonedMutexException is new in the .NET Framework version 2.0. 在舊版中,如果因已放棄 mutex 而完成等候,則 WaitAny 方法會傳回 trueIn previous versions, the WaitAny method returns true if the wait completes because 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.

只有在等候因已放棄的 mutex 而完成時,WaitAny 方法才會擲回 AbandonedMutexExceptionThe WaitAny method throws an AbandonedMutexException only when the wait completes because of an abandoned mutex. 如果 waitHandles 包含比放棄的 mutex 索引編號較低的已釋放 mutex,則 WaitAny 方法會正常完成,而且不會擲回例外狀況。If waitHandles contains a released mutex with a lower index number than the abandoned mutex, the WaitAny method completes normally and the exception is not thrown.

注意

在2.0 版之前的 .NET Framework 版本中,如果執行緒結束或中止,而未明確釋放 Mutex,而且該 Mutex 在另一個執行緒的 WaitAny 陣列中為索引0(零),則 WaitAny 傳回的索引為128,而不是0。In versions of the .NET Framework earlier than version 2.0, if a thread exits or aborts without explicitly releasing a Mutex, and that Mutex is at index 0 (zero) in a WaitAny array on another thread, the index returned by WaitAny is 128 instead of 0.

當任何控制碼收到信號時,這個方法會傳回。This method returns when any handle is signaled. 如果在呼叫期間,有一個以上的物件變成信號,則傳回值會是已發出信號之物件的陣列索引,其中包含所有已發出信號之物件的最小索引值。If more than one object becomes signaled during the call, the return value is the array index of the signaled object with the smallest index value of all the signaled objects.

等候控制碼的最大數目為64,如果目前的執行緒處於 STA 狀態,則為63。The maximum number of the wait handles is 64, and 63 if the current thread is in STA state.

呼叫這個方法多載相當於呼叫 WaitAny(WaitHandle[], Int32, Boolean) 方法多載,並為 exitContext指定 millisecondsTimeouttrue 的-1 (或 Timeout.Infinite)。Calling this method overload is equivalent to calling the WaitAny(WaitHandle[], Int32, Boolean) method overload and specifying -1 (or Timeout.Infinite) for millisecondsTimeout and true for exitContext.

WaitAny(WaitHandle[], Int32)

等候指定之陣列中有任何項目收到信號,使用 32 位元帶正負號的整數以指定時間間隔。Waits for any of the elements in the specified array to receive a signal, using a 32-bit signed integer to specify the time interval.

public:
 static int WaitAny(cli::array <System::Threading::WaitHandle ^> ^ waitHandles, int millisecondsTimeout);
public static int WaitAny (System.Threading.WaitHandle[] waitHandles, int millisecondsTimeout);
static member WaitAny : System.Threading.WaitHandle[] * int -> int
Public Shared Function WaitAny (waitHandles As WaitHandle(), millisecondsTimeout As Integer) As Integer

參數

waitHandles
WaitHandle[]

WaitHandle 陣列,包含目前執行個體將等候的物件。A WaitHandle array containing the objects for which the current instance will wait.

millisecondsTimeout
Int32

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

傳回

滿足等候條件之物件的陣列索引;如果沒有物件滿足等候條件,而且已經過相當於 WaitTimeout 的時間間隔,則為 millisecondsTimeoutThe array index of the object that satisfied the wait, or WaitTimeout if no object satisfied the wait and a time interval equivalent to millisecondsTimeout has passed.

例外狀況

waitHandles 參數是 nullThe waitHandles parameter is null.

-或--or- waitHandles 陣列中的一或多個物件為 nullOne or more of the objects in the waitHandles array is null.

waitHandles 中的物件數目超過系統允許的數目。The number of objects in waitHandles is greater than the system permits.

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.

waitHandles 是不含任何項目的陣列。waitHandles is an array with no elements.

waitHandles 陣列在另一個應用程式定義域中包含 WaitHandle 的 Transparent Proxy。The waitHandles array contains a transparent proxy for a WaitHandle in another application domain.

備註

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

只有在等候因已放棄的 mutex 而完成時,WaitAny 方法才會擲回 AbandonedMutexExceptionThe WaitAny method throws an AbandonedMutexException only when the wait completes because of an abandoned mutex. 如果 waitHandles 包含比放棄的 mutex 索引編號較低的已釋放 mutex,則 WaitAny 方法會正常完成,而且不會擲回例外狀況。If waitHandles contains a released mutex with a lower index number than the abandoned mutex, the WaitAny method completes normally and the exception is not thrown.

這個方法會在等候終止時,在任何控制碼收到信號或發生超時時傳回。This method returns when the wait terminates, either when any of the handles are signaled or when a timeout occurs. 如果在呼叫期間,有一個以上的物件變成信號,則傳回值會是已發出信號之物件的陣列索引,其中包含所有已發出信號之物件的最小索引值。If more than one object becomes signaled during the call, the return value is the array index of the signaled object with the smallest index value of all the signaled objects.

等候控制碼的最大數目為64,如果目前的執行緒處於 STA 狀態,則為63。The maximum number of the wait handles is 64, and 63 if the current thread is in STA state.

呼叫這個方法多載與呼叫 WaitAny(WaitHandle[], Int32, Boolean) 多載,並指定 exitContextfalse 相同。Calling this method overload is the same as calling the WaitAny(WaitHandle[], Int32, Boolean) overload and specifying false for exitContext.

WaitAny(WaitHandle[], TimeSpan)

等候指定陣列中的所有項目都收到信號,使用 TimeSpan 來指定時間間隔。Waits for any of the elements in the specified array to receive a signal, using a TimeSpan to specify the time interval.

public:
 static int WaitAny(cli::array <System::Threading::WaitHandle ^> ^ waitHandles, TimeSpan timeout);
public static int WaitAny (System.Threading.WaitHandle[] waitHandles, TimeSpan timeout);
static member WaitAny : System.Threading.WaitHandle[] * TimeSpan -> int
Public Shared Function WaitAny (waitHandles As WaitHandle(), timeout As TimeSpan) As Integer

參數

waitHandles
WaitHandle[]

WaitHandle 陣列,包含目前執行個體將等候的物件。A WaitHandle array containing the objects for which the current instance will wait.

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.

傳回

滿足等候條件之物件的陣列索引;如果沒有物件滿足等候條件,而且已經過相當於 WaitTimeout 的時間間隔,則為 timeoutThe array index of the object that satisfied the wait, or WaitTimeout if no object satisfied the wait and a time interval equivalent to timeout has passed.

例外狀況

waitHandles 參數是 nullThe waitHandles parameter is null.

-或--or- waitHandles 陣列中的一或多個物件為 nullOne or more of the objects in the waitHandles array is null.

waitHandles 中的物件數目超過系統允許的數目。The number of objects in waitHandles is greater than the system permits.

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.

waitHandles 是不含任何項目的陣列。waitHandles is an array with no elements.

waitHandles 陣列在另一個應用程式定義域中包含 WaitHandle 的 Transparent Proxy。The waitHandles array contains 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 handles and returns immediately.

只有在等候因已放棄的 mutex 而完成時,WaitAny 方法才會擲回 AbandonedMutexExceptionThe WaitAny method throws an AbandonedMutexException only when the wait completes because of an abandoned mutex. 如果 waitHandles 包含比放棄的 mutex 索引編號較低的已釋放 mutex,則 WaitAny 方法會正常完成,而且不會擲回例外狀況。If waitHandles contains a released mutex with a lower index number than the abandoned mutex, the WaitAny method completes normally and the exception is not thrown.

這個方法會在等候終止時,在任何控制碼收到信號或發生超時時傳回。This method returns when the wait terminates, either when any of the handles are signaled or when a time-out occurs. 如果在呼叫期間,有一個以上的物件變成信號,則傳回值會是已發出信號之物件的陣列索引,其中包含所有已發出信號之物件的最小索引值。If more than one object becomes signaled during the call, the return value is the array index of the signaled object with the smallest index value of all the signaled objects.

等候控制碼的最大數目為64,如果目前的執行緒處於 STA 狀態,則為63。The maximum number of the wait handles is 64, and 63 if the current thread is in STA state.

timeout 的最大值為 Int32.MaxValueThe maximum value for timeout is Int32.MaxValue.

呼叫這個方法多載與呼叫 WaitAny(WaitHandle[], TimeSpan, Boolean) 多載,並指定 exitContextfalse 相同。Calling this method overload is the same as calling the WaitAny(WaitHandle[], TimeSpan, Boolean) overload and specifying false for exitContext.

WaitAny(WaitHandle[], Int32, Boolean)

等候指定陣列中有任何項目收到信號;使用 32 位元帶正負號的整數 (Signed Integer) 來指定時間間隔,並指定是否在等候之前先離開同步處理領域。Waits for any of the elements in the specified array to receive 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:
 static int WaitAny(cli::array <System::Threading::WaitHandle ^> ^ waitHandles, int millisecondsTimeout, bool exitContext);
public static int WaitAny (System.Threading.WaitHandle[] waitHandles, int millisecondsTimeout, bool exitContext);
static member WaitAny : System.Threading.WaitHandle[] * int * bool -> int
Public Shared Function WaitAny (waitHandles As WaitHandle(), millisecondsTimeout As Integer, exitContext As Boolean) As Integer

參數

waitHandles
WaitHandle[]

WaitHandle 陣列,包含目前執行個體將等候的物件。A WaitHandle array containing the objects for which the current instance will wait.

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.

傳回

滿足等候條件之物件的陣列索引;如果沒有物件滿足等候條件,而且已經過相當於 WaitTimeout 的時間間隔,則為 millisecondsTimeoutThe array index of the object that satisfied the wait, or WaitTimeout if no object satisfied the wait and a time interval equivalent to millisecondsTimeout has passed.

例外狀況

waitHandles 參數是 nullThe waitHandles parameter is null.

-或--or- waitHandles 陣列中的一或多個物件為 nullOne or more of the objects in the waitHandles array is null.

waitHandles 中的物件數目超過系統允許的數目。The number of objects in waitHandles is greater than the system permits.

waitHandles 是不具有項目的陣列,且 .NET Framework 版本為 1.0 或 1.1。waitHandles is an array with no elements, and the .NET Framework version is 1.0 or 1.1.

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.

waitHandles 是不具有元素的陣列,且 .NET Framework 版本為 2.0 (含) 以後版本。waitHandles is an array with no elements, and the .NET Framework version is 2.0 or later.

waitHandles 陣列在另一個應用程式定義域中包含 WaitHandle 的 Transparent Proxy。The waitHandles array contains a transparent proxy for a WaitHandle in another application domain.

範例

下列程式碼範例示範如何使用執行緒集區,同時搜尋多個磁片上的檔案。The following code example demonstrates how to use the thread pool to simultaneously search for a file on multiple disks. 基於空間考慮,只會搜尋每個磁片的根目錄。For space considerations, only the root directory of each disk is searched.

using namespace System;
using namespace System::IO;
using namespace System::Threading;
ref class Search
{
private:

   // Maintain state information to pass to FindCallback.
   ref class State
   {
   public:
      AutoResetEvent^ autoEvent;
      String^ fileName;
      State( AutoResetEvent^ autoEvent, String^ fileName )
         : autoEvent( autoEvent ), fileName( fileName )
      {}

   };


public:
   array<AutoResetEvent^>^autoEvents;
   array<String^>^diskLetters;

   // Search for stateInfo->fileName.
   void FindCallback( Object^ state )
   {
      State^ stateInfo = dynamic_cast<State^>(state);
      
      // Signal if the file is found.
      if ( File::Exists( stateInfo->fileName ) )
      {
         stateInfo->autoEvent->Set();
      }
   }

   Search()
   {
      
      // Retrieve an array of disk letters.
      diskLetters = Environment::GetLogicalDrives();
      autoEvents = gcnew array<AutoResetEvent^>(diskLetters->Length);
      for ( int i = 0; i < diskLetters->Length; i++ )
      {
         autoEvents[ i ] = gcnew AutoResetEvent( false );

      }
   }


   // Search for fileName in the root directory of all disks.
   void FindFile( String^ fileName )
   {
      for ( int i = 0; i < diskLetters->Length; i++ )
      {
         Console::WriteLine(  "Searching for {0} on {1}.", fileName, diskLetters[ i ] );
         ThreadPool::QueueUserWorkItem( gcnew WaitCallback( this, &Search::FindCallback ), gcnew State( autoEvents[ i ],String::Concat( diskLetters[ i ], fileName ) ) );

      }
      
      // Wait for the first instance of the file to be found.
      int index = WaitHandle::WaitAny( autoEvents, 3000, false );
      if ( index == WaitHandle::WaitTimeout )
      {
         Console::WriteLine( "\n{0} not found.", fileName );
      }
      else
      {
         Console::WriteLine( "\n{0} found on {1}.", fileName, diskLetters[ index ] );
      }
   }

};

int main()
{
   Search^ search = gcnew Search;
   search->FindFile( "SomeFile.dat" );
}

using System;
using System.IO;
using System.Threading;

class Test
{
    static void Main()
    {
        Search search = new Search();
        search.FindFile("SomeFile.dat");
    }
}

class Search
{
    // Maintain state information to pass to FindCallback.
    class State
    {
        public AutoResetEvent autoEvent;
        public string         fileName;

        public State(AutoResetEvent autoEvent, string fileName)
        {
            this.autoEvent    = autoEvent;
            this.fileName     = fileName;
        }
    }

    AutoResetEvent[] autoEvents;
    String[] diskLetters;

    public Search()
    {
        // Retrieve an array of disk letters.
        diskLetters = Environment.GetLogicalDrives();

        autoEvents = new AutoResetEvent[diskLetters.Length];
        for(int i = 0; i < diskLetters.Length; i++)
        {
            autoEvents[i] = new AutoResetEvent(false);
        }
    }

    // Search for fileName in the root directory of all disks.
    public void FindFile(string fileName)
    {
        for(int i = 0; i < diskLetters.Length; i++)
        {
            Console.WriteLine("Searching for {0} on {1}.",
                fileName, diskLetters[i]);
            ThreadPool.QueueUserWorkItem(
                new WaitCallback(FindCallback), 
                new State(autoEvents[i], diskLetters[i] + fileName));
        }

        // Wait for the first instance of the file to be found.
        int index = WaitHandle.WaitAny(autoEvents, 3000, false);
        if(index == WaitHandle.WaitTimeout)
        {
            Console.WriteLine("\n{0} not found.", fileName);
        }
        else
        {
            Console.WriteLine("\n{0} found on {1}.", fileName,
                diskLetters[index]);
        }
    }

    // Search for stateInfo.fileName.
    void FindCallback(object state)
    {
        State stateInfo = (State)state;

        // Signal if the file is found.
        if(File.Exists(stateInfo.fileName))
        {
            stateInfo.autoEvent.Set();
        }
    }
}
Imports System.IO
Imports System.Threading

Public Class Test

    <MTAThread> _
    Shared Sub Main()
        Dim search As New Search()
        search.FindFile("SomeFile.dat")
    End Sub    
End Class

Public Class Search

    ' Maintain state information to pass to FindCallback.
    Class State
        Public autoEvent As AutoResetEvent 
        Public fileName As String         

        Sub New(anEvent As AutoResetEvent, fName As String)
            autoEvent = anEvent
            fileName = fName
        End Sub
    End Class

    Dim autoEvents() As AutoResetEvent
    Dim diskLetters() As String

    Sub New()

        ' Retrieve an array of disk letters.
        diskLetters = Environment.GetLogicalDrives()

        autoEvents = New AutoResetEvent(diskLetters.Length - 1) {}
        For i As Integer = 0 To diskLetters.Length - 1
            autoEvents(i) = New AutoResetEvent(False)
        Next i
    End Sub    
    
    ' Search for fileName in the root directory of all disks.
    Sub FindFile(fileName As String)
        For i As Integer = 0 To diskLetters.Length - 1
            Console.WriteLine("Searching for {0} on {1}.", _
                fileName, diskLetters(i))
        
            ThreadPool.QueueUserWorkItem(AddressOf FindCallback, _ 
                New State(autoEvents(i), diskLetters(i) & fileName))
        Next i

        ' Wait for the first instance of the file to be found.
        Dim index As Integer = _
            WaitHandle.WaitAny(autoEvents, 3000, False)
        If index = WaitHandle.WaitTimeout
            Console.WriteLine(vbCrLf & "{0} not found.", fileName)
        Else
            Console.WriteLine(vbCrLf & "{0} found on {1}.", _
                fileName, diskLetters(index))
        End If
    End Sub

    ' Search for stateInfo.fileName.
    Sub FindCallback(state As Object)
        Dim stateInfo As State = DirectCast(state, State)

        ' Signal if the file is found.
        If File.Exists(stateInfo.fileName) Then
            stateInfo.autoEvent.Set()
        End If
    End Sub

End Class

備註

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

AbandonedMutexException 是 .NET Framework 2.0 版的新功能。AbandonedMutexException is new in the .NET Framework version 2.0. 在舊版中,如果因已放棄 mutex 而完成等候,則 WaitAny 方法會傳回 trueIn previous versions, the WaitAny method returns true if the wait completes because 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.

只有在等候因已放棄的 mutex 而完成時,WaitAny 方法才會擲回 AbandonedMutexExceptionThe WaitAny method throws an AbandonedMutexException only when the wait completes because of an abandoned mutex. 如果 waitHandles 包含比放棄的 mutex 索引編號較低的已釋放 mutex,則 WaitAny 方法會正常完成,而且不會擲回例外狀況。If waitHandles contains a released mutex with a lower index number than the abandoned mutex, the WaitAny method completes normally and the exception is not thrown.

注意

在2.0 版之前的 .NET Framework 版本中,如果執行緒結束或中止,而未明確釋放 Mutex,而且該 Mutex 在另一個執行緒的 WaitAny 陣列中為索引0(零),則 WaitAny 傳回的索引為128,而不是0。In versions of the .NET Framework earlier than version 2.0, if a thread exits or aborts without explicitly releasing a Mutex, and that Mutex is at index 0 (zero) in a WaitAny array on another thread, the index returned by WaitAny is 128 instead of 0.

這個方法會在等候終止時,在任何控制碼收到信號或發生超時時傳回。This method returns when the wait terminates, either when any of the handles are signaled or when a timeout occurs. 如果在呼叫期間,有一個以上的物件變成信號,則傳回值會是已發出信號之物件的陣列索引,其中包含所有已發出信號之物件的最小索引值。If more than one object becomes signaled during the call, the return value is the array index of the signaled object with the smallest index value of all the signaled objects.

等候控制碼的最大數目為64,如果目前的執行緒處於 STA 狀態,則為63。The maximum number of the wait handles is 64, and 63 if the current thread is in STA state.

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

除非從非預設的 managed 內容中呼叫 WaitAny 方法,否則 exitContext 參數不會有任何作用。The exitContext parameter has no effect unless the WaitAny 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,會導致執行緒在執行 WaitAny 方法之前結束非預設的 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 WaitAny method. WaitAny 方法的呼叫完成後,執行緒會回到原始的非預設內容。The thread returns to the original nondefault context after the call to the WaitAny 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. 如果成員呼叫堆疊中的程式碼呼叫 WaitAny 方法,並指定 exitContexttrue,則執行緒會結束同步處理網域,允許在對物件的任何成員呼叫封鎖的執行緒繼續進行。If code in the call stack of a member calls the WaitAny 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. WaitAny 方法傳回時,進行呼叫的執行緒必須等待重新輸入同步處理網域。When the WaitAny method returns, the thread that made the call must wait to reenter the synchronization domain.

WaitAny(WaitHandle[], TimeSpan, Boolean)

等候指定陣列中的所有項目都收到信號,使用 TimeSpan 來指定時間間隔,並指定是否要先離開同步處理網域,再開始等候。Waits for any of the elements in the specified array to receive a signal, using a TimeSpan to specify the time interval and specifying whether to exit the synchronization domain before the wait.

public:
 static int WaitAny(cli::array <System::Threading::WaitHandle ^> ^ waitHandles, TimeSpan timeout, bool exitContext);
public static int WaitAny (System.Threading.WaitHandle[] waitHandles, TimeSpan timeout, bool exitContext);
static member WaitAny : System.Threading.WaitHandle[] * TimeSpan * bool -> int
Public Shared Function WaitAny (waitHandles As WaitHandle(), timeout As TimeSpan, exitContext As Boolean) As Integer

參數

waitHandles
WaitHandle[]

WaitHandle 陣列,包含目前執行個體將等候的物件。A WaitHandle array containing the objects for which the current instance will wait.

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.

傳回

滿足等候條件之物件的陣列索引;如果沒有物件滿足等候條件,而且已經過相當於 WaitTimeout 的時間間隔,則為 timeoutThe array index of the object that satisfied the wait, or WaitTimeout if no object satisfied the wait and a time interval equivalent to timeout has passed.

例外狀況

waitHandles 參數是 nullThe waitHandles parameter is null.

-或--or- waitHandles 陣列中的一或多個物件為 nullOne or more of the objects in the waitHandles array is null.

waitHandles 中的物件數目超過系統允許的數目。The number of objects in waitHandles is greater than the system permits.

waitHandles 是不具有項目的陣列,且 .NET Framework 版本為 1.0 或 1.1。waitHandles is an array with no elements, and the .NET Framework version is 1.0 or 1.1.

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.

waitHandles 是不具有元素的陣列,且 .NET Framework 版本為 2.0 (含) 以後版本。waitHandles is an array with no elements, and the .NET Framework version is 2.0 or later.

waitHandles 陣列在另一個應用程式定義域中包含 WaitHandle 的 Transparent Proxy。The waitHandles array contains a transparent proxy for a WaitHandle in another application domain.

範例

下列程式碼範例示範如何使用執行緒集區,同時搜尋多個磁片上的檔案。The following code example demonstrates how to use the thread pool to simultaneously search for a file on multiple disks. 基於空間考慮,只會搜尋每個磁片的根目錄。For space considerations, only the root directory of each disk is searched.

using namespace System;
using namespace System::IO;
using namespace System::Threading;
ref class Search
{
private:

   // Maintain state information to pass to FindCallback.
   ref class State
   {
   public:
      AutoResetEvent^ autoEvent;
      String^ fileName;
      State( AutoResetEvent^ autoEvent, String^ fileName )
         : autoEvent( autoEvent ), fileName( fileName )
      {}

   };


public:
   array<AutoResetEvent^>^autoEvents;
   array<String^>^diskLetters;

   // Search for stateInfo->fileName.
   void FindCallback( Object^ state )
   {
      State^ stateInfo = dynamic_cast<State^>(state);
      
      // Signal if the file is found.
      if ( File::Exists( stateInfo->fileName ) )
      {
         stateInfo->autoEvent->Set();
      }
   }

   Search()
   {
      
      // Retrieve an array of disk letters.
      diskLetters = Environment::GetLogicalDrives();
      autoEvents = gcnew array<AutoResetEvent^>(diskLetters->Length);
      for ( int i = 0; i < diskLetters->Length; i++ )
      {
         autoEvents[ i ] = gcnew AutoResetEvent( false );

      }
   }


   // Search for fileName in the root directory of all disks.
   void FindFile( String^ fileName )
   {
      for ( int i = 0; i < diskLetters->Length; i++ )
      {
         Console::WriteLine(  "Searching for {0} on {1}.", fileName, diskLetters[ i ] );
         ThreadPool::QueueUserWorkItem( gcnew WaitCallback( this, &Search::FindCallback ), gcnew State( autoEvents[ i ],String::Concat( diskLetters[ i ], fileName ) ) );

      }
      
      // Wait for the first instance of the file to be found.
      int index = WaitHandle::WaitAny( autoEvents, TimeSpan(0,0,3), false );
      if ( index == WaitHandle::WaitTimeout )
      {
         Console::WriteLine( "\n{0} not found.", fileName );
      }
      else
      {
         Console::WriteLine( "\n{0} found on {1}.", fileName, diskLetters[ index ] );
      }
   }

};

int main()
{
   Search^ search = gcnew Search;
   search->FindFile( "SomeFile.dat" );
}

using System;
using System.IO;
using System.Threading;

class Test
{
    static void Main()
    {
        Search search = new Search();
        search.FindFile("SomeFile.dat");
    }
}

class Search
{
    // Maintain state information to pass to FindCallback.
    class State
    {
        public AutoResetEvent autoEvent;
        public string         fileName;

        public State(AutoResetEvent autoEvent, string fileName)
        {
            this.autoEvent    = autoEvent;
            this.fileName     = fileName;
        }
    }

    AutoResetEvent[] autoEvents;
    String[] diskLetters;

    public Search()
    {
        // Retrieve an array of disk letters.
        diskLetters = Environment.GetLogicalDrives();

        autoEvents = new AutoResetEvent[diskLetters.Length];
        for(int i = 0; i < diskLetters.Length; i++)
        {
            autoEvents[i] = new AutoResetEvent(false);
        }
    }

    // Search for fileName in the root directory of all disks.
    public void FindFile(string fileName)
    {
        for(int i = 0; i < diskLetters.Length; i++)
        {
            Console.WriteLine("Searching for {0} on {1}.",
                fileName, diskLetters[i]);
            ThreadPool.QueueUserWorkItem(
                new WaitCallback(FindCallback), 
                new State(autoEvents[i], diskLetters[i] + fileName));
        }

        // Wait for the first instance of the file to be found.
        int index = WaitHandle.WaitAny(
            autoEvents, new TimeSpan(0, 0, 3), false);
        if(index == WaitHandle.WaitTimeout)
        {
            Console.WriteLine("\n{0} not found.", fileName);
        }
        else
        {
            Console.WriteLine("\n{0} found on {1}.", fileName,
                diskLetters[index]);
        }
    }

    // Search for stateInfo.fileName.
    void FindCallback(object state)
    {
        State stateInfo = (State)state;

        // Signal if the file is found.
        if(File.Exists(stateInfo.fileName))
        {
            stateInfo.autoEvent.Set();
        }
    }
}
Imports System.IO
Imports System.Threading

Public Class Test

    <MTAThread> _
    Shared Sub Main()
        Dim search As New Search()
        search.FindFile("SomeFile.dat")
    End Sub    
End Class

Public Class Search

    ' Maintain state information to pass to FindCallback.
    Class State
        Public autoEvent As AutoResetEvent 
        Public fileName As String         

        Sub New(anEvent As AutoResetEvent, fName As String)
            autoEvent = anEvent
            fileName = fName
        End Sub
    End Class

    Dim autoEvents() As AutoResetEvent
    Dim diskLetters() As String

    Sub New()

        ' Retrieve an array of disk letters.
        diskLetters = Environment.GetLogicalDrives()

        autoEvents = New AutoResetEvent(diskLetters.Length - 1) {}
        For i As Integer = 0 To diskLetters.Length - 1
            autoEvents(i) = New AutoResetEvent(False)
        Next i
    End Sub    
    
    ' Search for fileName in the root directory of all disks.
    Sub FindFile(fileName As String)
        For i As Integer = 0 To diskLetters.Length - 1
            Console.WriteLine("Searching for {0} on {1}.", _
                fileName, diskLetters(i))
        
            ThreadPool.QueueUserWorkItem(AddressOf FindCallback, _ 
                New State(autoEvents(i), diskLetters(i) & fileName))
        Next i

        ' Wait for the first instance of the file to be found.
        Dim index As Integer = WaitHandle.WaitAny( _
            autoEvents, New TimeSpan(0, 0, 3), False)
        If index = WaitHandle.WaitTimeout
            Console.WriteLine(vbCrLf & "{0} not found.", fileName)
        Else
            Console.WriteLine(vbCrLf & "{0} found on {1}.", _
                fileName, diskLetters(index))
        End If
    End Sub

    ' Search for stateInfo.fileName.
    Sub FindCallback(state As Object)
        Dim stateInfo As State = DirectCast(state, State)

        ' Signal if the file is found.
        If File.Exists(stateInfo.fileName) Then
            stateInfo.autoEvent.Set()
        End If
    End Sub

End Class

備註

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

AbandonedMutexException 是 .NET Framework 2.0 版的新功能。AbandonedMutexException is new in the .NET Framework version 2.0. 在舊版中,如果因已放棄 mutex 而完成等候,則 WaitAny 方法會傳回 trueIn previous versions, the WaitAny method returns true if the wait completes because 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.

只有在等候因已放棄的 mutex 而完成時,WaitAny 方法才會擲回 AbandonedMutexExceptionThe WaitAny method throws an AbandonedMutexException only when the wait completes because of an abandoned mutex. 如果 waitHandles 包含比放棄的 mutex 索引編號較低的已釋放 mutex,則 WaitAny 方法會正常完成,而且不會擲回例外狀況。If waitHandles contains a released mutex with a lower index number than the abandoned mutex, the WaitAny method completes normally and the exception is not thrown.

注意

在2.0 版之前的 .NET Framework 版本中,如果執行緒結束或中止,而未明確釋放 Mutex,而且該 Mutex 在另一個執行緒的 WaitAny 陣列中為索引0(零),則 WaitAny 傳回的索引為128,而不是0。In versions of the .NET Framework earlier than version 2.0, if a thread exits or aborts without explicitly releasing a Mutex, and that Mutex is at index 0 (zero) in a WaitAny array on another thread, the index returned by WaitAny is 128 instead of 0.

這個方法會在等候終止時,在任何控制碼收到信號或發生超時時傳回。This method returns when the wait terminates, either when any of the handles are signaled or when a time-out occurs. 如果在呼叫期間,有一個以上的物件變成信號,則傳回值會是已發出信號之物件的陣列索引,其中包含所有已發出信號之物件的最小索引值。If more than one object becomes signaled during the call, the return value is the array index of the signaled object with the smallest index value of all the signaled objects.

等候控制碼的最大數目為64,如果目前的執行緒處於 STA 狀態,則為63。The maximum number of the wait handles is 64, and 63 if the current thread is in STA state.

timeout 的最大值為 Int32.MaxValueThe maximum value for timeout is Int32.MaxValue.

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

除非從非預設的 managed 內容中呼叫 WaitAny 方法,否則 exitContext 參數不會有任何作用。The exitContext parameter has no effect unless the WaitAny 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,會導致執行緒在執行 WaitAny 方法之前結束非預設的 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 WaitAny method. WaitAny 方法的呼叫完成後,執行緒會回到原始的非預設內容。The thread returns to the original nondefault context after the call to the WaitAny 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. 如果成員呼叫堆疊中的程式碼呼叫 WaitAny 方法,並指定 exitContexttrue,則執行緒會結束同步處理網域,允許在對物件的任何成員呼叫封鎖的執行緒繼續進行。If code in the call stack of a member calls the WaitAny 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. WaitAny 方法傳回時,進行呼叫的執行緒必須等待重新輸入同步處理網域。When the WaitAny method returns, the thread that made the call must wait to reenter the synchronization domain.

適用於