MPI_Error_string - Returns a string for a given error code


SYNOPSIS

       C:

            #include <mpi.h>

            int MPI_Error_string( errorcode, string, resultlen )
            int  errorcode, *resultlen;
            char *string;

       C++:

            #include <mpi.h>

            void Get_error_string(
            int               errorcode,
            char*             name,
            int&              resultlen)

       Fortran:

            INCLUDE "mpif.h" (or USE MPI)

            INTEGER errorcode, resultlen, ierror
            CHARACTER*(*) string

            CALL MPI_ERROR_STRING(errorcode, *(*) string, resultlen,
            ierror)


STANDARDS

       This release implements the MPI 1.2 standard, as
       documented by the MPI Forum in the spring 1997 release of
       MPI:  A Message Passing Interface Standard.


DESCRIPTION

       The MPI_Error_string routine returns a string for a given
       error code.  This routine accepts the following
       parameters:

       errorcode      Specifies the error code returned by an MPI
                      routine or an MPI error class

       string         Returns text that corresponds to errorcode

       resultlen      Returns the length of string

       ierror         Specifies the return code value for
                      successful completion, which is in
                      MPI_SUCCESS.  MPI_SUCCESS is defined in the



NOTES

       Error codes are the values returned by MPI routines (in C)
       or in the ierr argument (in Fortran).  These can be
       converted to error classes by using the MPI_Error_class(3)
       routine.


SEE ALSO

       MPI_Error_class(3)


Man(1) output converted with man2html