clear_eventT_clear_eventClearEventClearEvent (Operator)

Name

clear_eventT_clear_eventClearEventClearEvent — Clear the event synchronization object.

Signature

Description

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.

This operator modifies the state of the following input parameter:

• EventHandleEventHandleEventHandleEventHandleeventHandle

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

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

See also

create_eventcreate_eventCreateEventCreateEventCreateEvent

Module

Foundation