Export (0) Print
Expand All

WaitHandle.WaitAny Method (WaitHandle[], TimeSpan)

Updated: July 2008

Waits for any of the elements in the specified array to receive a signal, using a TimeSpan to specify the time interval.

Namespace:  System.Threading
Assembly:  mscorlib (in mscorlib.dll)

public static int WaitAny(
	WaitHandle[] waitHandles,
	TimeSpan timeout
)

Parameters

waitHandles
Type: System.Threading.WaitHandle[]

A WaitHandle array containing the objects for which the current instance will wait.

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.Int32
The 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.

ExceptionCondition
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

timeout is a negative number other than -1 milliseconds, which represents an infinite time-out.

-or-

timeout is greater than Int32.MaxValue.

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 timeout 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 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. On some implementations, if more that 64 handles are passed, a NotSupportedException is thrown.

The maximum value for timeout is Int32.MaxValue.

Calling this method overload is the same as calling the WaitAny(WaitHandle[], TimeSpan, Boolean) overload and specifying false for exitContext.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5 SP1, 3.0 SP2, 2.0 SP2

Date

History

Reason

July 2008

Added topic for new overload.

.NET Framework 3.5 SP1 feature change.

Community Additions

ADD
Show:
© 2014 Microsoft