engGetVariable (C)

Copy variable from MATLAB engine workspace

C Syntax

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

Description

engGetVariable reads the named mxArray from the MATLAB^® engine session associated with ep.

The limit for the size of data transferred is 2 GB.

Use mxDestroyArray to destroy the mxArray created by this routine when you are finished with it.

Input Arguments

ep — Pointer to engine

Engine *

Pointer to engine, specified as Engine *.

name — Name of mxArray

const char *

Name of mxArray to get from the MATLAB workspace, specified as const char *.

Output Arguments

ptr — Pointer to mxArray

mxArray * | NULL

Pointer to a newly allocated mxArray structure, returned as mxArray *. Returns NULL if the attempt fails. engGetVariable fails if the named variable does not exist.

Examples

To open an example, type:

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

where filename is:

• engdemo.c for a C example on UNIX^® operating systems.

• engwindemo.c for a C example on Microsoft^® Windows^® operating systems.

Version History

Introduced before R2006a