Operator Reference

wait_eventT_wait_eventWaitEventWaitEventwait_event (Operator)

wait_eventT_wait_eventWaitEventWaitEventwait_event — Lock an event synchronization object.

Signature

wait_event( : : EventHandle : )

Herror T_wait_event(const Htuple EventHandle)

void WaitEvent(const HTuple& EventHandle)

void HEvent::WaitEvent() const

static void HOperatorSet.WaitEvent(HTuple eventHandle)

void HEvent.WaitEvent()

def wait_event(event_handle: HHandle) -> None

Description

wait_eventwait_eventWaitEventWaitEventwait_event waits on the event object passed in EventHandleEventHandleEventHandleeventHandleevent_handle until it is signaled. When the event is signaled, wait_eventwait_eventWaitEventWaitEventwait_event succeeds and sets the state automatically to non-signaled again. The kind of wait depends on the event's attributes set during the creation in create_eventcreate_eventCreateEventCreateEventcreate_event.

Execution Information

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

Parameters

EventHandleEventHandleEventHandleeventHandleevent_handle (input_control)  event HEvent, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Event synchronization object.

Result

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

Possible Predecessors

create_eventcreate_eventCreateEventCreateEventcreate_event

Possible Successors

signal_eventsignal_eventSignalEventSignalEventsignal_event

Module

Foundation