MATLAB^®

matGetNextVariable (C and Fortran) - Read next `mxArray` from MAT-file

C Syntax

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

Fortran Syntax

mwPointer matGetNextVariable(mfp, name)
mwPointer mfp
character*(*) name

Arguments

mfp: Pointer to MAT-file information
name: Address of the variable to contain the mxArray name

Returns

A pointer to a newly allocated mxArray structure representing the next mxArray from the MAT-file pointed to by mfp. The function returns the name of the mxArray in name.

matGetNextVariable returns NULL in C (0 in Fortran) when the end-of-file is reached or if there is an error condition. In C, use feof and ferror from the Standard C Library to determine status.

Description

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

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.

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

The order of variables returned from successive calls to matGetNextVariable is not guaranteed to be the same order in which the variables were written.

C Examples

See matdgns.c in the eng_mat subdirectory of the examples directory for a sample program that illustrates how to use the MATLAB^® MAT-file routines in a C program.

matGetNextVariable (C and Fortran) - Read next mxArray from MAT-file