Documentation

This is machine translation

Translated by Microsoft
Mouse over text to see original. Click the button below to return to the English verison of the page.

mxGetClassID (C and Fortran)

Class of array

C Syntax

#include "matrix.h"
mxClassID mxGetClassID(const mxArray *pm);

Fortran Syntax

integer*4 mxGetClassID(pm)
mwPointer pm

Arguments

pm

Pointer to an mxArray

Returns

Numeric identifier of the class (category) of the mxArray that pm points to. For a list of C-language class identifiers, see the mxClassID reference page. For user-defined types, mxGetClassId returns a unique value identifying the class of the array contents. Use mxIsClass to determine whether an array is of a specific user-defined type.

Description

Use mxGetClassId to determine the class of an mxArray. The class of an mxArray identifies the kind of data the mxArray is holding. For example, if pm points to a logical mxArray, then mxGetClassId returns mxLOGICAL_CLASS (in C).

mxGetClassId is like mxGetClassName, except that the former returns the class as an integer identifier and the latter returns the class as a string.

Examples

See the following examples in matlabroot/extern/examples/mex.

See the following examples in matlabroot/extern/examples/refbook.

Introduced before R2006a

Was this topic helpful?