mxGetImagData (External Interfaces/API Reference)

Get pointer to imaginary data of an mxArray

Fortran Syntax

integer*4 function mxGetImagData(pm)
integer*4 pm

Arguments

pm
Pointer to an mxArray.

Returns

The address of the first element of the imaginary data, on success. Returns 0 if there is no imaginary data or if there is an error.

Description

Call mxGetImagData to determine the starting address of the imaginary data in the mxArray that pm points to. To copy values from the pointer to Fortran, use one of the mxCopyPtrToComplex* functions in the manner shown here.

C      Get the real and imaginary data in mxArray, pm
       mxCopyPtrToComplex16(mxGetData(pm), mxGetImagData(pm),
     +               data, mxGetNumberOfElements(pm))

mxGetImagData is equivalent to using mxGetPi.

mxGetFieldNumber mxGetInf