mxIsClass (Fortran)

Determine whether mxArray is object of specified class

Fortran Syntax

#include "fintrf.h"
integer*4 mxIsClass(pm, classname)
mwPointer pm
character*(*) classname

Description

Each mxArray is tagged as being a certain type. mxIsClass returns 1 if the mxArray is of the specified type. Otherwise, the function returns 0.

MATLAB^® does not check if the class is derived from a base class.

In Fortran:

mxIsClass(pm, 'double')

is equivalent to calling either one of the following:

mxIsDouble(pm)
mxGetClassName(pm) .eq. 'double'

It is more efficient to use the mxIsDouble form.

Input Arguments

expand all

`pm` — MATLAB array
`mwPointer`

Pointer to an mxArray array, specified as mwPointer.

`classname` — Array category to test
`character()`

Array category to test, specified as character*(*). Use one of these predefined constants. Do not specify classname as an integer identifier.

Value of `classname`	Corresponding Class
`cell`	`mxCELL_CLASS`
`char`	`mxCHAR_CLASS`
`double`	`mxDOUBLE_CLASS`
`function_handle`	`mxFUNCTION_CLASS`
`int8`	`mxINT8_CLASS`
`int16`	`mxINT16_CLASS`
`int32`	`mxINT32_CLASS`
`int64`	`mxINT64_CLASS`
`logical`	`mxLOGICAL_CLASS`
`single`	`mxSINGLE_CLASS`
`struct`	`mxSTRUCT_CLASS`
`uint8`	`mxUINT8_CLASS`
`uint16`	`mxUINT16_CLASS`
`uint32`	`mxUINT32_CLASS`
`uint64`	`mxUINT64_CLASS`
`<class_name>`, which represents the name of a specific MATLAB custom object. You can also specify one of your own class names.	`<class_id>`
`unknown`	`mxUNKNOWN_CLASS`

Version History

Introduced before R2006a