try_wait_eventT_try_wait_eventTryWaitEventTryWaitEventtry_wait_event (Operator)
Name
try_wait_eventT_try_wait_eventTryWaitEventTryWaitEventtry_wait_event — Lock an event synchronization object only if it is unlocked.
Signature
Description
try_wait_eventtry_wait_eventTryWaitEventTryWaitEventTryWaitEventtry_wait_event behaves identically to wait_eventwait_eventWaitEventWaitEventWaitEventwait_event, 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_eventTryWaitEventTryWaitEventTryWaitEventtry_wait_event is returned in BusyBusyBusyBusybusybusy. 1 indicates
that the event was non-signaled before calling try_wait_eventtry_wait_eventTryWaitEventTryWaitEventTryWaitEventtry_wait_event,
0 that the event was signaled.
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
EventHandleEventHandleEventHandleEventHandleeventHandleevent_handle (input_control) event → HEvent, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Event synchronization object.
BusyBusyBusyBusybusybusy (output_control) number → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Object already locked?
Result
If the event handle is valid, the operator try_wait_eventtry_wait_eventTryWaitEventTryWaitEventTryWaitEventtry_wait_event
returns 2 (H_MSG_TRUE). If necessary, an exception is raised.
Possible Predecessors
create_eventcreate_eventCreateEventCreateEventCreateEventcreate_event
Possible Successors
signal_eventsignal_eventSignalEventSignalEventSignalEventsignal_event
See also
wait_eventwait_eventWaitEventWaitEventWaitEventwait_event
Module
Foundation