NAME

MPI_Error_class - Gets the class of an error from its error code

SYNOPSIS

#include <mpi.h> 
int MPI_Error_class(int errcode , int *errclass ); 
#include <pmpi.h> 
int PMPI_Error_class(int errcode , int *errclass ); 

INPUT PARAMETER

errcode - error code (integer)

OUTPUT PARAMETER

errclass - class of the error (integer)

DESCRIPTION

The MPI_Error_class() function is used to obtain the class, errclass of an error defined by the code errcode .

For this implementation of MPI, all this function does is set errclass to be MPI_UNKNOWN if it lies outside the list of normal MPI error codes. If errcode is a known MPI error, then errclass is simply set to the same value.

The resulting errclass is of the correct range to be used in the MPI_Error_string() function.

Note that it is possible to obtain error codes outside the normal range of MPI errors by using non-default error handlers, or by returning a non-standard code from a MPI_Copy_function or MPI_Delete_function.

PMPI_Error_class() is the profiling version of this function.

ERRORS

All MPI routines except for MPI_Wtime and MPI_Wtick return an error value. The the current MPI error handler is invoked if this return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable.

MPI_SUCCESS - No error;

MPI_ERR_ARG - Invalid pointer.

SEE ALSO

MPI_Errhandler_create (3) MPI_Errhandler_free (3) MPI_Errhandler_set (3) MPI_Errhandler_get (3) MPI_Error_string (3)

• Lockless
• MPI Documentation
• MPI_Error_class