mexGetVariablePtr (C and Fortran) - Read-only pointer to variable from another workspace

C Syntax

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

Fortran Syntax

mwPointer mexGetVariablePtr(workspace, varname)
character*(*) workspace, varname

Arguments

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 workspace.
global	Search for the variable in the global workspace.

varname

Name of a variable in another workspace. This is a variable name, not an mxArray pointer.

Returns

Read-only pointer to the mxArray on success. Returns NULL in C (0 in Fortran) on failure.

Description

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

If you simply want to examine data or characteristics, mexGetVariablePtr offers superior performance because the caller wants to pass only a pointer to the array.

Examples

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

• mxislogical.c

See Also

mexGetVariable

Recommended Products

• MATLAB
• Signal Processing Toolbox
• Optimization Toolbox
• Statistics Toolbox
• Control System Toolbox

Get MATLAB trial software

Includes the most popular MATLAB recorded presentations with Q&A sessions led by MATLAB experts.

Get the Interactive Kit