mxCreateStructMatrix (C)

2-D structure array

expand all in page

C Syntax

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

Description

CallmxCreateStructMatrixto create an unpopulated, two-dimensional, structuremxArray. For information about the structure, seemxCreateStructArray.

CallmxDestroyArraywhen you finish using themxArrayto deallocate themxArrayand its associated elements.

Input Arguments

expand all

`m`— Number of rows
`mwSize`

Number of rows, specified asmwSize.

`n`— Number of columns
`mwSize`

Number of columns, specified asmwSize.

`nfields`— Number of fields
`int`

Number of fields in each element, specified asint.

`fieldnames`— Field names
`const char **`

One or more field names, specified asconst char **.

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

Output Arguments

expand all

`pm`— Pointer to`mxArray`
`mxArray *`|`NULL`

Pointer to anmxArray, specified asmxArray *, if successful.

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

MEX file — Function terminates the MEX file and returns control to the MATLAB prompt.
Standalone (non-MEX file) application — Function returns0.

Examples

See these examples inmatlabroot/extern/examples/refbook:

phonebook.c

mxCreateStructMatrix (C)

C Syntax

Description