ClassesClassesClassesClasses | | | | Operators

clear_matrixclear_matrixClearMatrixclear_matrixClearMatrixClearMatrix (Operator)

Name

clear_matrixclear_matrixClearMatrixclear_matrixClearMatrixClearMatrix — Free the memory of a matrix.

Signature

clear_matrix( : : MatrixID : )

Herror clear_matrix(const Hlong MatrixID)

Herror T_clear_matrix(const Htuple MatrixID)

Herror clear_matrix(const HTuple& MatrixID)

void ClearMatrix(const HTuple& MatrixID)

void HOperatorSetX.ClearMatrix([in] VARIANT MatrixID)

static void HOperatorSet.ClearMatrix(HTuple matrixID)

Description

The operator clear_matrixclear_matrixClearMatrixclear_matrixClearMatrixClearMatrix frees the memory of the matrix MatrixMatrixMatrixMatrixMatrixmatrix given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID. After calling clear_matrixclear_matrixClearMatrixclear_matrixClearMatrixClearMatrix, the MatrixMatrixMatrixMatrixMatrixmatrix can no longer be used. The matrix handle MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID becomes invalid.

Parallelization

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control)  matrix(-array) HMatrix, HTupleHTupleHMatrix, HTupleHMatrixX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Matrix handle.

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixcreate_matrixCreateMatrixCreateMatrix

See also

clear_all_matricesclear_all_matricesClearAllMatricesclear_all_matricesClearAllMatricesClearAllMatrices

Module

Foundation


ClassesClassesClassesClasses | | | | Operators