Error values for the scda functions. More...

#include <sc_scda.h>

Data Fields
int	mpiret
	MPI function return value; without MPI this variable can get filled by other I/O operation error codes, which are still interpretable by the error scda examination functions.

sc_scda_ret_t	scdaret
	scda file format related return value

Detailed Description

Error values for the scda functions.

An error value is a struct since the error can be related to the scda file format or to (MPI) I/O operations. The error code can be converted to a string by sc_scda_ferror_string, mapped to an error class by sc_scda_ferror_class and checked for success by sc_scda_ferror_is_success. The user can rely on these functions to parse sc_scda_ferror and does not need to access the members of this structure.

The parsing logic of sc_scda_ferror_t is that first scdaret is examined and if scdaret != SC_SCDA_FERR_MPI, we know that mpiret = 0. If scdaret = SC_SCDA_FERR_MPI, we know that an MPI error occurred and we can examine mpiret for more informartion.

Moreover, a valid sc_scda_ferror always satisfy that if scdaret = 0 then mpiret = 0 and if scdaret = SC_SCDA_FERR_MPI then mpiret !=0.

The documentation for this struct was generated from the following file:

src/sc_scda.h

Data Fields

Detailed Description