MPI_Error_string(3)

NAME
MPI_Error_string - Gets a string that corresponds to a given MPI error code

SYNOPSIS
#include <mpi.h>
int MPI_Error_string(int errcode, char *out, int *len);

#include <pmpi.h>
int PMPI_Error_string(int errcode, char *out, int *len);

#include <mpi.h>
void MPI::Get_error_string(int errcode, char *out, int &len);

INCLUDE 'mpif.h'
MPI_ERROR_STRING(errcode, out, len, ierr)
CHARACTER*(*) out
INTEGER errcode, len, ierr

INPUT PARAMETER
errcode
    - error code (integer)

OUTPUT PARAMETERS
out - buffer to write the string into (array)
len - length of the string (integer)

DESCRIPTION
The MPI_Error_string() function is used to obtain a string, out that corresponds to a given get the error code, errcode. out should be a buffer large enough to hold the largest error string. (Which may be up to MPI_MAX_ERROR_STRING bytes in length). When the string is written, len is filled with the length of the string. If the error code is invalid, then MPI_ERR_ARG will be returned, and no string will be written. PMPI_Error_string() 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_class(3)