MATLAB®

mxIsStruct (C and Fortran) - Determine whether input is structure mxArray

C Syntax

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

Fortran Syntax

integer*4 mxIsStruct(pm)
mwPointer pm

Arguments

pm

Pointer to an mxArray

Returns

Logical 1 (true) if pm points to a structure mxArray, and logical 0 (false) otherwise.

Description

Use mxIsStruct to determine whether pm points to a structure mxArray. Many routines (for example, mxGetFieldName and mxSetField) require a structure mxArray as an argument.

C Examples

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

See Also

mxCreateStructArray, mxCreateStructMatrix, mxGetNumberOfFields, mxGetField, mxSetField

mxIsSparse (C and Fortran)

mxIsUint16 (C and Fortran)