mxIsFromGlobalWS (C)

Determine whether mxArray was copied from MATLAB global workspace

C Syntax

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

Description

The function returns logical 1 (true) if the array was copied out of the global workspace. Otherwise, it returns logical 0 (false). Use mxIsFromGlobalWS for standalone MAT-file programs.

Input Arguments

pm — MATLAB array

const mxArray*

Pointer to an mxArray array, specified as const mxArray*.

Examples

See these examples in matlabroot/extern/examples/eng_mat:

• matcreat.c

• matdgns.c

Version History

Introduced before R2006a