External Interfaces/API Reference

mxCreateLogicalScalar

Create scalar, logical mxArray initialized to false

C Syntax

• #include "matrix.h"
  mxArray *mxCreateLogicalScalar(mxLOGICAL value);
  

Arguments

value
   The desired logical value (true or false) to which you want to initialize the array.

Returns

A pointer to the created mxArray, if successful. mxCreateLogicalScalar is unsuccessful if there is not enough free heap space to create the mxArray. If mxCreateLogicalScalar is unsuccessful in a MEX-file, the MEX-file prints an "Out of Memory" message, terminates, and control returns to the MATLAB prompt. If mxCreateLogicalScalar is unsuccessful in a stand-alone (nonMEX-file) application, the function returns NULL.

Description

Call mxCreateLogicalScalar to create a scalar logical mxArray. mxCreateLogicalScalar is a convenience function that can be used in place of the following code:

• pa = mxCreateLogicalMatrix(1, 1);
  *mxGetLogicals(pa) = value;
  

When you finish using the mxArray, call mxDestroyArray to destroy it.

See Also

mxIsLogicalScalar, mxIsLogicalScalarTrue, mxCreateLogicalMatrix, mxCreateLogicalArray, mxGetLogicals

mxCreateLogicalMatrix

mxCreateNumericArray