C Syntax

#include "matrix.h"
void mxDestroyArray(mxArray *pm);

Fortran Syntax

subroutine mxDestroyArray(pm)
mwPointer pm

Arguments

pm

Pointer to the mxArray to free

Description

mxDestroyArray deallocates the memory occupied by the specified mxArray including:

• Characteristics fields of the mxArray, such as size (m and n) and type.

• Associated data arrays, such as pr and pi for complex arrays, and ir and jc for sparse arrays.

• Fields of structure arrays.

• Cells of cell arrays.

Do not call mxDestroyArray on an mxArray:

• returned in a left-side argument of a MEX file.

• returned by the mxGetField or mxGetFieldByNumber functions.

• returned by the mxGetCell function.

Examples

See the following examples in matlabroot/extern/examples/refbook.

• matrixDivide.cmatrixDivide.c

• matrixDivideComplex.cmatrixDivideComplex.c

• sincall.csincall.c

• sincall.Fsincall.F

See the following examples in matlabroot/extern/examples/mex.

• mexcallmatlab.cmexcallmatlab.c

• mexgetarray.cmexgetarray.c

See the following examples in matlabroot/extern/examples/mx.

• mxisclass.cmxisclass.c

• mxcreatecellmatrixf.Fmxcreatecellmatrixf.F

See Also

mxCalloc, mxMalloc, mxFree, mexMakeArrayPersistent, mexMakeMemoryPersistent