Documentation Center

  • Trial Software
  • Product Updates

mxIsUint16 (C and Fortran)

Determine whether array represents data as unsigned 16-bit integers

C Syntax

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

Fortran Syntax

integer*4 mxIsUint16(pm)
mwPointer pm

Arguments

pm

Pointer to an mxArray

Returns

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

Description

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

In C, calling mxIsUint16 is equivalent to calling:

mxGetClassID(pm) == mxUINT16_CLASS

In Fortran, calling mxIsUint16 is equivalent to calling:

mxGetClassName(pm) .eq. 'uint16'
Was this topic helpful?