MATLAB®

mxCreateStructMatrix (C and Fortran) - Create unpopulated 2-D structure mxArray

C Syntax

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

Fortran Syntax

mwPointer mxCreateStructMatrix(m, n, nfields, fieldnames)
mwSize m, n
integer*4 nfields
character*(*) fieldnames(nfields)

Arguments

m

The desired number of rows. This must be a positive integer.

n

The desired number of columns. This must be a positive integer.

nfields

The desired number of fields in each element.

fieldnames

The desired list of field names.

Each structure field name must begin with a letter and is case sensitive. The rest of the name may contain letters, numerals, and underscore characters. Use the namelengthmax function to determine the maximum length of a field name.

Returns

A pointer to the created structure mxArray if successful, and NULL in C (0 in Fortran) otherwise. The most likely cause of failure is insufficient heap space to hold the returned mxArray.

Description

mxCreateStructMatrix and mxCreateStructArray are almost identical. The only difference is that mxCreateStructMatrix can create only two-dimensional mxArrays, while mxCreateStructArray can create mxArrays having two or more dimensions.

C Examples

See phonebook.c in the refbook subdirectory of the examples directory.

See Also

mxCreateStructArray

mxCreateStructArray (C and Fortran)

mxDestroyArray (C and Fortran)