WaitHandle::WaitAny Method (array<WaitHandle^>^, Int32)
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.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- waitHandles
-
Type:
array<System.Threading::WaitHandle^>^
A WaitHandle array containing the objects for which the current instance will wait.
- millisecondsTimeout
-
Type:
System::Int32
The number of milliseconds to wait, or Timeout::Infinite (-1) to wait indefinitely.
Return Value
Type: System::Int32The 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.
| Exception | Condition |
|---|---|
| ArgumentNullException | The waitHandles parameter is null. -or- One or more of the objects in the waitHandles array is null. |
| NotSupportedException | The number of objects in waitHandles is greater than the system permits. |
| ArgumentOutOfRangeException | millisecondsTimeout is a negative number other than -1, which represents an infinite time-out. |
| AbandonedMutexException | The wait completed because a thread exited without releasing a mutex. This exception is not thrown on Windows 98 or Windows Millennium Edition. |
| ArgumentException | waitHandles is an array with no elements. |
| InvalidOperationException | The waitHandles array contains a transparent proxy for a WaitHandle in another application domain. |
If millisecondsTimeout is zero, the method does not block. It tests the state of the wait handles and returns immediately.
The WaitAny method throws an AbandonedMutexException only when the wait completes because of an abandoned mutex. 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. On some implementations, if more that 64 handles are passed, a NotSupportedException is thrown.
Calling this method overload is the same as calling the WaitAny(array<WaitHandle^>^, Int32, Boolean) overload and specifying false for exitContext.
Available since 8
.NET Framework
Available since 2.0
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