wait_eventwait_eventWaitEventwait_eventWaitEventWaitEvent (Operator)

Name

wait_eventwait_eventWaitEventwait_eventWaitEventWaitEvent — Lock an event synchronization object.

Signature

Description

wait_eventwait_eventWaitEventwait_eventWaitEventWaitEvent waits on the event object passed in EventHandleEventHandleEventHandleEventHandleEventHandleeventHandle until it is signaled. When the event is signaled, wait_eventwait_eventWaitEventwait_eventWaitEventWaitEvent succeeds and sets the state automatically to nonsignaled again. The kind of wait depends on the event's attributes set during the creation in create_eventcreate_eventCreateEventcreate_eventCreateEventCreateEvent.

Parallelization

• Multithreading type: independent (runs in parallel even with exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

Result

If the event handle is valid, the operator wait_eventwait_eventWaitEventwait_eventWaitEventWaitEvent returns 2 (H_MSG_TRUE). If necessary, an exception is raised.

Possible Predecessors

create_eventcreate_eventCreateEventcreate_eventCreateEventCreateEvent

Possible Successors

signal_eventsignal_eventSignalEventsignal_eventSignalEventSignalEvent

Module

Foundation