External Interfaces/API Reference

matGetNextVariable

Read next mxArray from MAT-file

C Syntax

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

Arguments

mfp
   Pointer to MAT-file information.

name
   Address of the variable to contain the mxArray name.

Description

matGetNextVariable allows you to step sequentially through a MAT-file and read all the mxArrays in a single pass. The function reads the next mxArray from the MAT-file pointed to by mfp and returns a pointer to a newly allocated mxArray structure. MATLAB returns the name of the mxArray in name.

Use matGetNextVariable immediately after opening the MAT-file with matOpen and not in conjunction with other MAT-file routines. Otherwise, the concept of the next mxArray is undefined.

matGetNextVariable returns NULL when the end-of-file is reached or if there is an error condition. Use feof and ferror from the Standard C Library to determine status.

Be careful in your code to free the mxArray created by this routine when you are finished with it.

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.

matGetNextMatrix (Obsolete)

matGetNextVariableInfo