clear_handleT_clear_handleClearHandleClearHandle (Operator)

Name

clear_handleT_clear_handleClearHandleClearHandle — Clear the content of a handle.

Signature

clear_handle( : : Handle : )

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.

This operator modifies the state of the following input parameter:

HandleHandleHandleHandlehandle

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

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

Handle to clear.

Result

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

Module

Foundation

Operators