mxCreateStructMatrix (C)

2-D structure array

C Syntax

#include "matrix.h"
mxArray *mxCreateStructMatrix(mwSize m, mwSize n, int nfields, const char **fieldnames);

Description

Call mxCreateStructMatrix to create an unpopulated, two-dimensional, structure mxArray. For information about the structure, see mxCreateStructArray.

Call mxDestroyArray when you finish using the mxArray to deallocate the mxArray and its associated elements.

Input Arguments

m — Number of rows

mwSize

Number of rows, specified as mwSize.

n — Number of columns

mwSize

Number of columns, specified as mwSize.

nfields — Number of fields

int

Number of fields in each element, specified as int.

fieldnames — Field names

const char **

One or more field names, specified as const char **.

Field names must be valid MATLAB^® identifiers, which means they cannot be NULL or empty. Field names are case-sensitive. To determine the maximum length of a field name, use the namelengthmax function.

Output Arguments

pm — Pointer to mxArray

mxArray * | NULL

Pointer to an mxArray, specified as mxArray *, if successful.

The function is unsuccessful when there is not enough free heap space to create the mxArray.

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

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

Examples

To open an example, type:

edit([fullfile(matlabroot,"extern","examples","refbook","filename")]);

where filename is:

• phonebook.c

Version History

Introduced before R2006a