Operator Reference

HALCON Operator Reference / System / Multithreading
ClassesClasses | | Operators

clear_eventT_clear_eventClearEventClearEventclear_event (Operator)

clear_eventT_clear_eventClearEventClearEventclear_event — Clear the event synchronization object.

Signature

clear_event( : : EventHandle : )

Herror T_clear_event(const Htuple EventHandle)

void ClearEvent(const HTuple& EventHandle)

void HEvent::ClearEvent() const

static void HOperatorSet.ClearEvent(HTuple eventHandle)

void HEvent.ClearEvent()

def clear_event(event_handle: HHandle) -> None

Description

clear_eventclear_eventClearEventClearEventclear_event destroys the mutex object given by EventHandleEventHandleEventHandleeventHandleevent_handle. No threads should be waiting on the event at the time clear_eventclear_eventClearEventClearEventclear_event is called. After calling clear_eventclear_eventClearEventClearEventclear_event, the event can no longer be used. The handle EventHandleEventHandleEventHandleeventHandleevent_handle 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:

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

Parameters

EventHandleEventHandleEventHandleeventHandleevent_handle (input_control, state is modified)  event → HEvent, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Event synchronization object.

Result

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

Possible Predecessors

create_eventcreate_eventCreateEventCreateEventcreate_event

See also

create_eventcreate_eventCreateEventCreateEventcreate_event

Module

Foundation

ClassesClasses | | Operators