mxIsLogicalScalarTrue (C)

Determine whether scalar array of type mxLogical is true

C Syntax

#include "matrix.h"
bool mxIsLogicalScalarTrue(const mxArray *array_ptr);

Arguments

array_ptr

Pointer to an mxArray

Returns

Logical 1 (true) if the value of the mxArray logical, scalar element is true. Otherwise, it returns logical 0 (false).

Description

Use mxIsLogicalScalarTrue to determine whether the value of a scalar mxArray is true or false.

Version History

Introduced before R2006a