try_wait_eventtry_wait_eventTryWaitEventtry_wait_eventTryWaitEventTryWaitEvent (Operator)

Name

try_wait_eventtry_wait_eventTryWaitEventtry_wait_eventTryWaitEventTryWaitEvent — Lock an event synchronization object only if it is unlocked.

Signature

Description

try_wait_eventtry_wait_eventTryWaitEventtry_wait_eventTryWaitEventTryWaitEvent behaves identically to wait_eventwait_eventWaitEventwait_eventWaitEventWaitEvent, except that it does not block the calling thread when waiting until the object is signaled but returns immediately. The state of the event before entering try_wait_eventtry_wait_eventTryWaitEventtry_wait_eventTryWaitEventTryWaitEvent is returned in BusyBusyBusyBusyBusybusy. 1 indicates that the event was nonsignaled before calling try_wait_eventtry_wait_eventTryWaitEventtry_wait_eventTryWaitEventTryWaitEvent, 0 that the event was signaled.

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 try_wait_eventtry_wait_eventTryWaitEventtry_wait_eventTryWaitEventTryWaitEvent returns 2 (H_MSG_TRUE). If necessary, an exception is raised.

Possible Predecessors

create_eventcreate_eventCreateEventcreate_eventCreateEventCreateEvent

Possible Successors

signal_eventsignal_eventSignalEventsignal_eventSignalEventSignalEvent

See also

wait_eventwait_eventWaitEventwait_eventWaitEventWaitEvent

Module

Foundation