Operator Reference

clear_conditionT_clear_conditionClearConditionClearConditionclear_condition (Operator)

clear_conditionT_clear_conditionClearConditionClearConditionclear_condition — Destroy a condition synchronization object.

Signature

clear_condition( : : ConditionHandle : )

Herror T_clear_condition(const Htuple ConditionHandle)

void ClearCondition(const HTuple& ConditionHandle)

void HCondition::ClearCondition() const

static void HOperatorSet.ClearCondition(HTuple conditionHandle)

void HCondition.ClearCondition()

def clear_condition(condition_handle: HHandle) -> None

Description

clear_conditionclear_conditionClearConditionClearConditionclear_condition destroys the condition object given in ConditionHandleConditionHandleConditionHandleconditionHandlecondition_handle. No threads should be waiting on the condition at the time clear_conditionclear_conditionClearConditionClearConditionclear_condition is called. After calling clear_conditionclear_conditionClearConditionClearConditionclear_condition, the condition can no longer be used. The handle ConditionHandleConditionHandleConditionHandleconditionHandlecondition_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

ConditionHandleConditionHandleConditionHandleconditionHandlecondition_handle (input_control, state is modified)  condition HCondition, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Condition synchronization object.

Result

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

Possible Predecessors

create_conditioncreate_conditionCreateConditionCreateConditioncreate_condition

See also

create_conditioncreate_conditionCreateConditionCreateConditioncreate_condition

Module

Foundation