wclMessageBroadcasterWait(WaitHandle, UInt32, UInt32) Method |
Waits until one or all of the specified objects are in the
signaled state or the time-out interval elapses.
Namespace: wclCommonAssembly: wclCommon (in wclCommon.dll) Version: 7.11.10.0 (7.11.10.0)
Syntax public static int Wait(
WaitHandle[] Events,
uint Timeout,
out uint Index
)
Public Shared Function Wait (
Events As WaitHandle(),
Timeout As UInteger,
<OutAttribute> ByRef Index As UInteger
) As Integer
public:
static int Wait(
array<WaitHandle^>^ Events,
unsigned int Timeout,
[OutAttribute] unsigned int% Index
)
Parameters
- Events WaitHandle
- An array of object handles. The maximum number of object
handles is 64.
- Timeout UInt32
- The time-out interval, in milliseconds. If a
nonzero value is specified, the function waits until the event is
signaled or the interval elapses. If Timeout is zero, the
function does not enter a wait state if the event is not signaled;
it always returns immediately. If Timeout is INFINITE,
the function will return only when the event is signaled.
- Index UInt32
- If the function completed with success on output
contains the index of the signaled object.
Return Value
Int32 If the function succeed the returns value is
WCL_E_SUCCESS. Otherwise the function returns one
of the WCL error codes.
See Also