ClassesClasses | | Operators

clear_eventclear_eventClearEventClearEvent (Operator)

Name

clear_eventclear_eventClearEventClearEvent — Clear the event synchronization object.

Signature

clear_event( : : EventHandle : )

Herror clear_event(const Hlong EventHandle)

Herror T_clear_event(const Htuple EventHandle)

void ClearEvent(const HTuple& EventHandle)

static void HOperatorSet.ClearEvent(HTuple eventHandle)

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

Parameters

EventHandleEventHandleEventHandleEventHandleeventHandle (input_control)  event HEvent, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

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

See also

create_eventcreate_eventCreateEventCreateEventCreateEvent

Module

Foundation


ClassesClasses | | Operators