mxIsStruct (C)

Determine whether mxArray is structure

C Syntax

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

Description

mxIsStruct returns logical 1 (true) if pm points to a structure mxArray. Otherwise, it returns logical 0 (false). Many routines (for example, mxGetFieldNameByNumber and mxSetField) require a structure mxArray as an argument.

Input Arguments

pm — MATLAB array

const mxArray*

Pointer to an mxArray array, specified as const mxArray*.

Examples

See these examples in matlabroot/extern/examples/refbook:

• phonebook.c

Version History

Introduced before R2006a