Main Content

mxGetDimensions (C)

Pointer to dimensions array

expand all in page

C Syntax

#include "matrix.h"
const mwSize *mxGetDimensions(const mxArray *pm);

Description

mxGetDimensions returns a pointer to the first element in the dimensions array. Each integer in the dimensions array represents the number of elements in a particular dimension. The array is not NULL terminated.

Use mxGetDimensions to determine how many elements are in each dimension of the mxArray that pm points to. Call mxGetNumberOfDimensions to get the number of dimensions in the mxArray.

Input Arguments

expand all

Pointer to an mxArray array, specified as const mxArray*.

Examples

See these examples in matlabroot/extern/examples/mx:

See these examples in matlabroot/extern/examples/refbook:

See these examples in matlabroot/extern/examples/mex:

Version History

Introduced before R2006a

See Also