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 Version History.

Fortran Syntax

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

Description

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

pm — Pointer to MATLAB^® array

mwPointer

Pointer to a MATLAB array, specified as mwPointer.

Output Arguments

pi — Pointer to complex data array

mwPointer | 0

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

R2018b: Do not use separate complex API

MathWorks recommends that you create MEX files and update existing MEX files to use the typed, data-access functions in the interleaved complex API. These functions verify that the input array is complex and of the correct type for the function. For more information, see:

• Typed Data Access in C MEX Files

• MATLAB Support for Interleaved Complex API in MEX Functions

• Upgrade MEX Files to Use Interleaved Complex API

To build the MEX file, call mex with the -R2018a option.

R2018b: Error building mxGetImagData with interleaved complex API

The mxGetImagData function is only available in the separate complex API. To build myMexFile.F using this function, type:

mex -R2017b myMexFile.F

Existing MEX files built with this function continue to run.