Skip to content

clear_conditionClearConditionClearConditionclear_conditionT_clear_condition🔗

Short description🔗

clear_conditionClearConditionClearConditionclear_conditionT_clear_condition — Destroy a condition synchronization object.

Signature🔗

clear_condition( condition ConditionHandle )void ClearCondition( const HTuple& ConditionHandle )static void HOperatorSet.ClearCondition( HTuple conditionHandle )def clear_condition( condition_handle: HHandle ) -> None

Herror T_clear_condition( const Htuple ConditionHandle )

void HCondition::ClearCondition( ) const

void HCondition.ClearCondition( )

Description🔗

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

ConditionHandleconditionHandlecondition_handle (input_control, state is modified) condition → (handle)HTuple (HHandle)HCondition, HTuple (IntPtr)HHandleHtuple (handle)

Condition synchronization object.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

create_conditionCreateCondition

See also

create_conditionCreateCondition

Module🔗

Foundation