mexGetVariablePtr (External Interfaces/API Reference)

Get a read-only pointer to a variable from the specified workspace

Fortran Syntax

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

Arguments

varname
Name of the variable to copy. (Note that this is a variable name, not an mxArray pointer.)

workspace
Specifies which workspace you want mexGetVariablePtr to search. 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

Returns

A read-only pointer to the mxArray on success. Returns 0 on failure.

Description

Call mexGetVariablePtr to get a read-only pointer to the specified variable varname from the specified workspace. This command is useful for examining an mxArray's data and characteristics. If you need to change data or characteristics, use mexGetVariable (along with mexPutVariable) instead of mexGetVariablePtr.

See Also

mexGetVariable

mexGetVariable mexIsFinite (Obsolete)