mxGetImagData (C)

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.

C Syntax

#include "matrix.h"
void *mxGetImagData(const mxArray *pm);

Description

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

Input Arguments

pm — Pointer to MATLAB^® array

mxArray *

Pointer to a MATLAB array, specified as mxArray *.

Output Arguments

pi — Pointer to complex data array

void * | NULL

Pointer to the complex data array within an mxArray, specified as void *. 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. For information on mapping MATLAB types to their equivalent C types, see mxClassID.

If pm is NULL, then the function returns NULL.

Complex Number Support: Yes

Version History

Introduced before R2006a

R2018a: 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

• Example explore.c

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

R2018a: Error building mxGetImagData with interleaved complex API

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

mex -R2017b myMexFile.c

Existing MEX files built with this function continue to run.