mxSetComplexInt16s (Fortran)

Set complex data elements in mxINT16_CLASS array

Fortran Syntax

#include "fintrf.h"
interger*4 mxSetComplexInt16s(pa, dt)
mwPointer pa, dt

Description

Use mxSetComplexInt16s to set mxComplexInt16 data in the specified array.

All mxCreate* functions allocate heap space to hold data. Therefore, you do not ordinarily use this function to initialize the elements of an array. Rather, call the function to replace existing values with new values.

This function does not free memory allocated for existing data. To free existing memory, call mxFree on the pointer returned by mxGetComplexInt16s.

Input Arguments

expand all

Pointer to an mxINT16_CLASS array.

Pointer to the first mxComplexInt16 element of the data array. dt must be allocated by the functions mxCalloc or mxMalloc.

Output Arguments

expand all

Function status, returned as interger*4. If successful, then the function returns 1.

If pa is 0, then the function returns 0.

The function is unsuccessful when mxArray is not an unshared mxINT16_CLASS array, or if the data is not allocated with mxCalloc. If the function is unsuccessful, then:

  • MEX file — Function terminates the MEX file and returns control to the MATLAB® prompt.

  • Standalone (non-MEX file) application — Function returns 0.

API Version

This function is available in the interleaved complex API. To build myMexFile.F using this function, type:

mex -R2018a myMexFile.F

Introduced in R2018b