TwclMessageBroadcaster.Wait(Cardinal,PWOHandleArray,Cardinal,Cardinal) Method

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

Namespace: wclMessaging

public
 class function Wait(const Count: Cardinal; const Events: PWOHandleArray;
 const Timeout: Cardinal; out Index: Cardinal): Integer; overload;

Count: Type: Cardinal
The number of object handles in the array pointed to by Events. The maximum number of object handles is 64.
Events: Type: PWOHandleArray
An array of object handles.
Timeout: Type: Cardinal
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: Type: Cardinal
If the function completed with success on output contains the index of the signaled object.

Type: Integer

If the function succeed the returns value is wclErrors.WCL_E_SUCCESS. Otherwise the function returns one of the WCL error codes.