TwclMessageBroadcaster.Wait(Cardinal,PWOHandleArray,Cardinal) Method

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

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

Parameters

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.

Index
Type: Cardinal

If the function completed with success on output contains the index of the signaled object.

Return Value

Type: Integer

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