clear_eventclear_eventclear_eventClearEventClearEvent (Operator)

Name

clear_eventclear_eventclear_eventClearEventClearEvent — Clear the event synchronization object.

Signature

Description

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

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

Possible Predecessors

create_eventcreate_eventcreate_eventCreateEventCreateEvent

See also

create_eventcreate_eventcreate_eventCreateEventCreateEvent, clear_all_eventsclear_all_eventsclear_all_eventsClearAllEventsClearAllEvents

Module

Foundation