MPI_Error_class(3)

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);

#include <mpi.h>
int MPI::Get_error_class(int errcode);

INCLUDE 'mpif.h'
MPI_ERROR_CLASS(errcode, errclass, ierr)
INTEGER errcode, errclass, ierr

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, this function sets 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 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. The C++ version of this function passes the resulting error class in it's return value. PMPI_Error_class() is the profiling version of this function.

ERRORS
All MPI routines except for MPI_Wtime and MPI_Wtick return an error code. The the current MPI error handler is invoked if the 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. In C, the error code is passed as the return value. In FORTRAN, all functions have an parameter ierr which returns the error code. MPI C++ functions do not directly return an error code. However, C++ users may want to use the MPI::ERRORS_THROW_EXCEPTIONS handler. This will throw an MPI::Exception with the corresponding error code. To prevent exceptions from being raised from within C and Fortran code, they will see all error return values as MPI_ERR_PENDING when this handler is chosen. In this implementation, call MPI::throw_exception() to throw the correct exception if this occurs.
MPI_SUCCESS
    - No error;
MPI_ERR_PENDING
    - Pending exception;
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)