Skip to content

wait_eventWaitEventWaitEventwait_eventT_wait_event🔗

Short description🔗

wait_eventWaitEventWaitEventwait_eventT_wait_event — Lock an event synchronization object.

Signature🔗

wait_event( event EventHandle )void WaitEvent( const HTuple& EventHandle )static void HOperatorSet.WaitEvent( HTuple eventHandle )def wait_event( event_handle: HHandle ) -> None

Herror T_wait_event( const Htuple EventHandle )

void HEvent::WaitEvent( ) const

void HEvent.WaitEvent( )

Description🔗

wait_eventWaitEvent waits on the event object passed in EventHandleeventHandleevent_handle until it is signaled. When the event is signaled, wait_eventWaitEvent 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_eventCreateEvent.

Execution information🔗

Execution information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

Parameters🔗

EventHandleeventHandleevent_handle (input_control) event → (handle)HTuple (HHandle)HEvent, HTuple (IntPtr)HHandleHtuple (handle)

Event synchronization object.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

create_eventCreateEvent

Possible successors

signal_eventSignalEvent

Module🔗

Foundation