mexGetVariable (External Interfaces/API Reference)

Get a copy of a variable from the specified workspace

Fortran Syntax

integer*4 function mexGetVariable(workspace, varname)
character*(*) workspace, varname

Arguments

workspace
Specifies where mexGetVariable should search in order to find variable varname. The possible values are:

base
Search for the variable in the base workspace

caller
Search for the variable in the caller's workspace

global
Search for the variable in the global workspace

`base`	Search for the variable in the base workspace
`caller`	Search for the variable in the caller's workspace
`global`	Search for the variable in the global workspace

varname
Name of the variable to copy.

Returns

A copy of the variable on success. Returns 0 on failure. A common cause of failure is specifying a variable that is not currently in the workspace.

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.

See Also

mexGetVariablePtr, mexPutVariable

mexGetNaN (Obsolete) mexGetVariablePtr