Main Content

mxGetImagData (Fortran)

Imaginary data elements in numeric mxArray

mxGetImagData is not available in the interleaved complex API. Use typed, data-access functions instead. For more information, see Compatibility Considerations.

Fortran Syntax

#include "fintrf.h"
mwPointer mxGetImagData(pm)
mwPointer pm


The mxGetImagData function is similar to mxGetPi, except that it returns a mwPointer. For more information, see the description for the mxGetData function.

Input Arguments

expand all

Pointer to a MATLAB array, specified as mwPointer.

Output Arguments

expand all

Pointer to the complex data array within an mxArray, specified as mwPointer. Since void pointers point to a value that has no type, cast the return value to the pointer type that matches the type specified by pm.

If pm is 0, then the function returns 0.

Complex Number Support: Yes

Version History

Introduced before R2006a

expand all

Not recommended starting in R2018b

Errors starting in R2018b