Skip to content

clear_handleClearHandleClearHandleclear_handleT_clear_handle🔗

Short description🔗

clear_handleClearHandleClearHandleclear_handleT_clear_handle — Clear the content of a handle.

Signature🔗

clear_handle( tuple Handle )void ClearHandle( const HTuple& Handle )static void HOperatorSet.ClearHandle( HTuple handle )def clear_handle( handle: MaybeSequence[HHandle] ) -> None

Herror T_clear_handle( const Htuple Handle )

void HTuple::ClearHandle( ) const

void HHandle::ClearHandle( ) const

void HTuple.ClearHandle( )

void HHandle.ClearHandle( )

Description🔗

clear_handleClearHandle clears the content of the handle contained in Handlehandlehandle. The handle is left in a cleared state afterwards. Attempts to use it in any other operator will raise an error.

Usually, handles are automatically cleared once all references in all tuples are overwritten. clear_handleClearHandle can be used to clear a handle at a specific time, even if there are still references to it.

This operator can be used to clear handles of any type instead of the more specialized operators, such as clear_matrixClearMatrix or clear_shape_modelClearShapeModel.

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🔗

Handlehandlehandle (input_control, state is modified) tuple(-array) → (handle)HTuple (HHandle)HTuple (HHandle)MaybeSequence[HHandle]Htuple (handle)

Handle to clear.

Result🔗

If the parameters are valid, the operator clear_handleClearHandle returns the value 2 (H_MSG_TRUE). Otherwise, an exception is raised.

Combinations with other operators🔗

Combinations

See also

tuple_is_valid_handleTupleIsValidHandle

Module🔗

Foundation