mexGetVariable (C) - Copy of variable from specified workspace - MATLAB (original) (raw)

Main Content

Copy of variable from specified workspace

C Syntax

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

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 returnedmxArray 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 forvarname, specified as const char*. The possible values are:

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

To open an example, type:

edit([fullfile(matlabroot,"extern","examples","mex","filename")]);

where filename is:

• mexgetarray.c

Version History

Introduced before R2006a