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.

mxIsUint8 (C and Fortran)

Determine whether array represents data as unsigned 8-bit integers

C Syntax

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

Fortran Syntax

integer*4 mxIsUint8(pm)
mwPointer pm

Arguments

pm

Pointer to an mxArray

Returns

Logical 1 (true) if the mxArray stores its data as unsigned 8-bit integers, and logical 0 (false) otherwise.

Description

Use mxIsUint8 to determine whether the specified mxArray represents its real and imaginary data as 8-bit unsigned integers.

In C, calling mxIsUint8 is equivalent to calling:

mxGetClassID(pm) == mxUINT8_CLASS

In Fortran, calling mxIsUint8 is equivalent to calling:

mxGetClassName(pm) .eq. 'uint8'

Introduced before R2006a

Was this topic helpful?