mxIsFromGlobalWS (MATLAB Application Program Interface)

True if the mxArray was copied from MATLAB's global workspace

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

Arguments

array_ptr
Pointer to an mxArray.

Returns

true if the array was copied out of the global workspace; otherwise, returns false.

Description

mxIsFromGlobalWS is useful for stand-alone mat and engine programs. mexIsGlobal tells you if the pointer you pass actually points into the global workspace.

Example

bool f;
.
.
.
f = mexIsGlobal(prhs[0]);
if (f) {
    other_array = mxDuplicateArray(prhs[0]);
    f = mxIsFromGlobalWS(other_array);
    if (f)
        mexPrintf("The copy was made from the global WS.");
    else
        mexPrintf("The copy was not made from the global WS.");
    }