wait_eventT_wait_eventWaitEventWaitEvent (Operator)

Name

wait_eventT_wait_eventWaitEventWaitEvent — 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()

Description

wait_eventwait_eventWaitEventWaitEventWaitEvent waits on the event object passed in EventHandleEventHandleEventHandleEventHandleeventHandle until it is signaled. When the event is signaled, wait_eventwait_eventWaitEventWaitEventWaitEvent 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_eventCreateEventCreateEventCreateEvent.

Execution Information

Parameters

EventHandleEventHandleEventHandleEventHandleeventHandle (input_control)  event HEvent, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Event synchronization object.

Result

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

Possible Predecessors

create_eventcreate_eventCreateEventCreateEventCreateEvent

Possible Successors

signal_eventsignal_eventSignalEventSignalEventSignalEvent

Module

Foundation