External Interfaces Reference

mxIsStruct

Determine if input is structure mxArray

C Syntax

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

Arguments

array_ptr
   Pointer to an mxArray.

Returns

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

Description

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

Examples

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

See Also

mxCreateStructArray, mxCreateStructMatrix, mxGetNumberOfFields,
mxGetField, mxSetField

mxIsString (Obsolete)

mxIsUint8

© 1994-2005 The MathWorks, Inc.