clear_eventclear_eventClearEventClearEvent (Operator)

Name

clear_eventclear_eventClearEventClearEvent — Clear the event synchronization object.

clear_eventclear_eventClearEventClearEventClearEvent destroys the mutex object given by EventHandleEventHandleEventHandleEventHandleeventHandle. No threads should be waiting on the event at the time clear_eventclear_eventClearEventClearEventClearEvent is called. After calling clear_eventclear_eventClearEventClearEventClearEvent, the event can no longer be used. The handle EventHandleEventHandleEventHandleEventHandleeventHandle becomes invalid.

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

EventHandleEventHandleEventHandleEventHandleeventHandle (input_control) event → (integer)

Event synchronization object.

Result

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

Possible Predecessors

create_eventcreate_eventCreateEventCreateEventCreateEvent

Module

Foundation

Operators