This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English version of the page.

Note: This page has been translated by MathWorks. Click here to see
To view all translated materials including this page, select Country from the country navigator on the bottom of this page.

mexGetVariable (C)

Copy of variable from specified workspace

C Syntax

#include "mex.h"
mxArray *mexGetVariable(const char *workspace, const char 
  *varname);

Description

Note

To write MEX functions using modern C++ features and the MATLAB Data API, see C++ MEX Applications.

Call mexGetVariable to get a copy of the specified variable. The returned mxArray contains a copy of all the data and characteristics that the variable had in the other workspace. Modifications to the returned mxArray do not affect the variable in the workspace unless you write the copy back to the workspace with mexPutVariable.

Use mxDestroyArray to destroy the mxArray created by this routine when you are finished with it.

Input Arguments

expand all

Workspace mexGetVariable searches for varname, specified as const char*. The possible values are:

base

Search for the variable in the base workspace.

caller

Search for the variable in the caller workspace.

global

Search for the variable in the global workspace.

Name of the variable to copy, specified as const char*.

Output Arguments

expand all

Copy of variable, specified as mxArray*. The function returns NULL on failure. A common cause of failure is specifying a variable that is not currently in the workspace. Perhaps the variable was in the workspace at one time but has since been cleared.

Examples

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

Introduced before R2006a