17.2.92. MPI_Error_class

MPI_Error_class - Converts an error code into an error class.

17.2.92.1. SYNTAX

17.2.92.1.1. C Syntax

#include <mpi.h>

int MPI_Error_class(int errorcode, int *errorclass)

17.2.92.1.2. Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_ERROR_CLASS(ERRORCODE, ERRORCLASS, IERROR)
     INTEGER ERRORCODE, ERRORCLASS, IERROR

17.2.92.1.3. Fortran 2008 Syntax

USE mpi_f08
MPI_Error_class(errorcode, errorclass, ierror)
     INTEGER, INTENT(IN) :: errorcode
     INTEGER, INTENT(OUT) :: errorclass
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.92.2. INPUT PARAMETER

  • errorcode: Error code returned by an MPI routine.

17.2.92.3. OUTPUT PARAMETERS

  • errorclass: Error class associated with errorcode.

  • IERROR: Fortran only: Error status (integer).

17.2.92.4. DESCRIPTION

The function MPI_Error_class maps each standard error code (error class) onto itself.

17.2.92.5. ERRORS

Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument.

Before the error value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error.

See also

MPI_Error_string