MATLAB^®

mxGetCell (C and Fortran) - Get contents of `mxArray` cell

C Syntax

#include "matrix.h"
mxArray *mxGetCell(const mxArray *pm, mwIndex index);

Fortran Syntax

mwPointer mxGetCell(pm, index)
mwPointer pm
mwIndex 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 NULL in C (0 in Fortran) otherwise. Causes of failure include

Specifying the index of a cell array element that has not been populated.
Specifying a 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 a MATLAB argument causes unpredictable results.

C Examples

See explore.c in the mex subdirectory of the examples directory.

mxGetCell (C and Fortran) - Get contents of mxArray cell