mxGetDimensions (External Interfaces/API Reference)

Get a pointer to the dimensions array

Fortran Syntax

integer*4 function mxGetDimensions(pm)
integer*4 pm

Arguments

pm
Pointer to an mxArray.

Returns

A pointer to the first element in a dimension array. Each integer in the dimensions array represents the number of elements in a particular dimension.

Description

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.

mxGetDimensions returns a pointer to the dimension array. To copy the values to Fortran, use mxCopyPtrToInteger4 in the manner shown here.

C      Get dimensions of mxArray, pm
       mxCopyPtrToInteger4(mxGetDimensions(pm), dims, 
     +                      mxGetNumberOfDimensions(pm))

See Also

mxGetNumberOfDimensions

mxGetData mxGetElementSize