mxIsChar (C)

Determine whether input is mxChar array

C Syntax

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

Description

mxIsChar returns logical 1 (true) if pm points to an mxChar array. Otherwise, it returns logical 0 (false).

In C, calling mxIsChar is equivalent to calling:

mxGetClassID(pm) == mxCHAR_CLASS

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

• revord.c

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

• mxcreatecharmatrixfromstr.c

• mxmalloc.c

Version History

Introduced before R2006a