wclWaitableSyncObjectWaitAny(wclWaitableSyncObject, UInt32) Method

Waits until one of the specified objects are in the signaled state or the time-out interval elapses.

Namespace: wclSync
Assembly: wclCommon (in wclCommon.dll) Version: 7.13.7.0 (7.13.7.0)

Syntax

public static uint WaitAny(
	wclWaitableSyncObject[] Objects,
	uint Timeout
)

Public Shared Function WaitAny ( 
	Objects As wclWaitableSyncObject(),
	Timeout As UInteger
) As UInteger

public:
static unsigned int WaitAny(
	array<wclWaitableSyncObject^>^ Objects, 
	unsigned int Timeout
)

Parameters

Objects wclWaitableSyncObject: An array of waitable objects.
Timeout UInt32: The wait timeout value.

Return Value

UInt32
If the wait completed with success the returning value is a signaled object index starting from WAIT_OBJECT_0. If the wait operation completed with success but one of the waitable object is a mutex and the thread that owned that mutex has exited without releasing the mutex the returning value is a mutex index starting from WAIT_ABANDONED_0. If the time-out elapsed the returning value is WAIT_TIMEOUT. If the wait failed the returning value is WAIT_FAILED.

Reference

wclWaitableSyncObject Class

wclWaitableSyncObject