External Interfaces/API Reference

mxGetCell

Get a cell's contents

Fortran Syntax

• integer*4 function mxGetCell(pm, index)
  integer*4 pm, index
  

Arguments

pm
   Pointer to a cell mxArray.

index
   The number of elements in the cell mxArray between the first element and the desired one. See mxCalcSingleSubscript for details on calculating an index in a multidimensional cell array.

Returns

A pointer to the ith cell mxArray if successful, and 0 otherwise. Causes of failure include:

• The indexed cell array element has not been populated.
• Specifying an array pointer, pm, that does not point to a cell mxArray.
• Specifying an index greater than the number of elements in the cell.
• Insufficient free heap space to hold the returned cell mxArray.

Description

Call mxGetCell to get a pointer to the mxArray held in the indexed element of the cell mxArray.

Note    Inputs to a MEX-file are constant read-only mxArrays and should not be modified. Using mxSetCell* or mxSetField* to modify the cells or fields of an argument passed from MATLAB causes unpredictable results.

See Also

mxCreateCellArray, mxIsCell, mxSetCell

mxFreeMatrix (Obsolete)

mxGetClassID