clear_handleT_clear_handleClearHandleClearHandle (Operator)

Name

clear_handleT_clear_handleClearHandleClearHandle — Clear the content of a handle.

Signature

Description

clear_handleclear_handleClearHandleClearHandleClearHandle clears the content of the handle contained in HandleHandleHandleHandlehandle. 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_handleclear_handleClearHandleClearHandleClearHandle 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_matrixclear_matrixClearMatrixClearMatrixClearMatrix or clear_shape_modelclear_shape_modelClearShapeModelClearShapeModelClearShapeModel.

Execution Information

• Multithreading type: independent (runs in parallel even with exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

Result

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

See also

tuple_is_valid_handletuple_is_valid_handleTupleIsValidHandleTupleIsValidHandleTupleIsValidHandle

Module

Foundation