MATLAB Application Program Interface Reference Help Desk

engGetFull

Purpose

Read full mxArrays from an engine

Fortran Syntax

Arguments

ep

Engine pointer.

name

Name of mxArray to get or put into engine's workspace.

m

Row dimension.

n

Column dimension.

pr

Pointer to real part.

pi

Pointer to imaginary part.

Description

Most MATLAB applications work only with full (nonsparse) mxArrays. This routine provides an easy way to copy a full mxArray from a MATLAB engine process. It offers an alternative to engGetMatrix, which does not require use of the mxArray structure.

engGetFull reads the named mxArray from the engine pointed to by ep and places the row dimensions, column dimensions, real array pointer, and imaginary array pointer into the locations specified by m, n, pr, and pi, respectively.

engGetFull returns 0 if successful, and 1 otherwise.

engGetFull allocates memory for the real and imaginary arrays using mxCalloc; use mxFree to return it when you are done.

If the mxArray is purely real, the imaginary pointer is given 0.

Example

See fengdemo.f in the eng_mat subdirectory of the examples directory for a sample program that illustrates how to call the MATLAB engine functions from a Fortran program.

Note: Fortran engine routines are not available on Windows.



[ Previous | Help Desk | Next ]