engGetArray (MATLAB Application Program Interface)

Copy a variable from a MATLAB engine's workspace

#include "engine.h"
mxArray *engGetArray(Engine *ep, const char *name);

Arguments

ep

Engine pointer.

name
Name of mxArray to get from engine.

Description

This routine allows you to copy a variable out of the workspace.

engGetArray reads the named mxArray from the engine pointed to by ep and returns a pointer to a newly allocated mxArray structure, or NULL if the attempt fails. engGetArray will fail if:

The named variable does not exist.
(V4 compatible mode under UNIX, or any mode under Windows) The named variable is not a MATLAB 4 data type.

Be careful in your code to free the mxArray created by this routine when you are finished with it.

Example

See engdemo.c in the eng_mat subdirectory of the examples directory for a sample program that illustrates how to call the MATLAB engine functions from a C program.