engGetVariable (Fortran)

Copy variable from MATLAB engine workspace

Fortran Syntax

#include "engine.h"
mwPointer engGetVariable(ep, name)
mwPointer ep
character*(*) name

Description

engGetVariable reads the named mxArray from the MATLAB^® engine session associated with ep. Returns 0 if successful and 1 if an error occurs.

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

mwPointer

Pointer to engine, specified as mwPointer.

name — Name of mxArray

character*(*)

Name of mxArray to get from the MATLAB workspace, specified as character*(*).

pm — Pointer to mxArray

mwPointer

Pointer to mxArray, specified as mwPointer.

Output Arguments

ptr — Pointer to mxArray

mwPointer | NULL

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

Version History

Introduced before R2006a