Skip to content

clear_eventClearEventClearEventclear_eventT_clear_event🔗

Short description🔗

clear_eventClearEventClearEventclear_eventT_clear_event — Clear the event synchronization object.

Signature🔗

clear_event( event EventHandle )void ClearEvent( const HTuple& EventHandle )static void HOperatorSet.ClearEvent( HTuple eventHandle )def clear_event( event_handle: HHandle ) -> None

Herror T_clear_event( const Htuple EventHandle )

void HEvent::ClearEvent( ) const

void HEvent.ClearEvent( )

Description🔗

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

Execution information🔗

Execution information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

This operator modifies the state of the following input parameter:

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

Parameters🔗

EventHandleeventHandleevent_handle (input_control, state is modified) event → (handle)HTuple (HHandle)HEvent, HTuple (IntPtr)HHandleHtuple (handle)

Event synchronization object.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

create_eventCreateEvent

See also

create_eventCreateEvent

Module🔗

Foundation