clear_handleT_clear_handleClearHandleClearHandle (Operator)


clear_handleT_clear_handleClearHandleClearHandle — Clear the content of a handle.


clear_handle( : : Handle : )

Herror T_clear_handle(const Htuple Handle)

void ClearHandle(const HTuple& Handle)

void HTuple::ClearHandle() const

void HHandle::ClearHandle() const

static void HOperatorSet.ClearHandle(HTuple handle)

void HTuple.ClearHandle()

void HHandle.ClearHandle()


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

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.


HandleHandleHandleHandlehandle (input_control, state is modified)  tuple(-array) HTupleHTupleHtuple (handle) (HHandle) (HHandle) (handle)

Handle to clear.


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

See also