mxIsStruct (C)

Determine whether mxArray is structure

expand all in page

C Syntax

#include "matrix.h" bool mxIsStruct(const mxArray *pm);

Description

mxIsStructreturns logical1(true) ifpmpoints to a structuremxArray. Otherwise, it returns logical0(false). Many routines (for example,mxGetFieldNameByNumberandmxSetField) require a structuremxArrayas an argument.

Input Arguments

expand all

`pm`— MATLAB array
`const mxArray*`

Pointer to anmxArrayarray, specified asconst mxArray*.

Examples

See these examples inmatlabroot/extern/examples/refbook:

phonebook.c

Version History

Introduced before R2006a