C Syntax

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

Fortran Syntax

#include "fintrf.h"
mwPointer mexGetVariable(workspace, varname)
character*(*) workspace, varname

Arguments

workspace

Specifies where mexGetVariable searches for array varname. 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.

varname

Name of the variable to copy

Returns

Copy of the variable on success. Returns NULL in C (0 on Fortran) 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.

Description

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.

Examples

See the following examples in matlabroot/extern/examples/mex.

• mexgetarray.c

See Also

mexGetVariablePtr, mexPutVariable, mxDestroyArray