matGetVariableInfo (C and Fortran)
Array header information only
C Syntax
#include "mat.h" mxArray *matGetVariableInfo(MATFile *mfp, const char *name);
Fortran Syntax
#include "mat.h" 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
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 nonzero values when loaded with matGetVariable
, matGetVariableInfo
sets
them to -1
instead. These headers are for informational use only. Never pass
this data back to the MATLAB® workspace or save it to MAT-files.
Use mxDestroyArray
to destroy the mxArray
created
by this routine when you are finished with it.
See Also
Version History
Introduced before R2006a