MATLAB^®

matGetVariableInfo (C and Fortran) - Load array header information only

C Syntax

#include "mat.h"
mxArray *matGetVariableInfo(MATFile *mfp, const char *name);

Fortran Syntax

mwPointer matGetVariableInfo(mfp, name);
mwPointer mfp
character*(*) name

Arguments

mfp: Pointer to MAT-file information
name: Name of mxArray to get from MAT-file

Returns

A pointer to a newly allocated mxArray structure representing header information for the mxArray named by name from the MAT-file pointed to by mfp.

matGetVariableInfo returns NULL in C (0 in Fortran) if the attempt to return header information for the mxArray named by name fails.

Description

matGetVariableInfo loads only the array header information, including everything except pr, pi, ir, and jc. It recursively creates the cells and structures through their leaf elements, but does not include pr, pi, ir, and jc.

If pr, pi, ir, and jc are set to nonzero values when loaded with matGetVariable, matGetVariableInfo sets them to -1 instead. These headers are for informational use only and should never be passed back to the MATLAB^® workspace or saved to MAT-files.

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

C Examples

See matcreat.c and matdgns.c in the eng_mat subdirectory of the examples directory for sample programs that illustrate how to use the MATLAB MAT-file routines in a C program.