MATLAB Application Program Interface Reference Help Desk

mxIsClass

Purpose

True if mxArray is a member of the specified class

C Syntax

Arguments

array_ptr

Pointer to an array.

name

The array category that you are testing. Specify name as a string (not as an enumerated constant). You can specify any one of the predefined constants, which are:

Value of Name

Corresponding Class

"double"

mxDOUBLE_ARRAY

"sparse"

mxSPARSE_ARRAY

"char"

mxCHARACTER_ARRAY

"cell"

mxCELL_ARRAY

"struct"

mxSTRUCTURE_ARRAY

"single"

mxFLOAT_ARRAY

"int8"

mxINT8_ARRAY

"uint8"

mxUINT8_ARRAY

"int16"

mxINT16_ARRAY

"uint16"

mxUINT16_ARRAY

"int32"

mxINT32_ARRAY

"uint32"

mxUINT32_ARRAY

Or, you can specify one of your own class names.

Returns

true if array_ptr points to an array having category name; otherwise, returns false.

Description

Each mxArray is tagged as being a certain type. Call mxIsClass to determine if the specified mxArray has this type.

Example

See mxIsClass.c in the mx subdirectory of the examples directory.

See Also

mxIsEmpty, mxGetClassID, mxClassID



[ Previous | Help Desk | Next ]