Main Content

mxGetN (C)

Number of columns in mxArray

C Syntax

#include "matrix.h"
size_t mxGetN(const mxArray *pm);

Description

mxGetN returns the number of columns in the specified mxArray.

If pm is an N-dimensional mxArray, mxGetN is the product of dimensions 2 through N. For example, if pm points to a four-dimensional mxArray having dimensions 13-by-5-by-4-by-6, mxGetN returns the value 120 (5 × 4 × 6). If the specified mxArray has more than two dimensions, then call mxGetDimensions to find out how many elements are in each dimension.

If pm points to a sparse mxArray, mxGetN still returns the number of columns, not the number of occupied columns.

Input Arguments

expand all

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

Examples

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

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

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

Introduced before R2006a