Open MPI logo

MPI_Add_error_string(3) man page (version 1.3.4)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing


       MPI_Add_error_string - Associates a string with an error code or class


C Syntax

       #include <mpi.h>
       int MPI_Add_error_string(int errorcode, char *string)

Fortran Syntax

       INCLUDE 'mpif.h'
            INTEGER        ERRORCODE, IERROR
            CHARACTER*(*)  STRING

C++ Syntax

       #include <mpi.h>
       void MPI::Add_error_string(int errorcode, const char* string)


       errorcode     MPI error class, or an error code returned by an MPI rou-
                     tine (integer).

       string        Text  that  corresponds  to  the  error  code  or   class


       IERROR        Fortran only: Error status (integer).


       This  routine  associates  an error string with an error code or class.
       Calling MPI_Add_error_string for an error code or  class  that  already
       has an associated error string will replace the old string with the new
       one. It is erroneous to call MPI_Add_error_string for  an  error  value
       not  generated  via MPI_Add_error_class or MPI_Add_error_code (e.g., an
       error code or class with a value not greater than MPI_LAST_ERRCODE).


       Almost all MPI routines return an error value; C routines as the  value
       of  the  function  and Fortran routines in the last argument. C++ func-
       tions do not return errors. If the default  error  handler  is  set  to
       MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism
       will be used to throw an MPI:Exception object.

       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.

1.3.4                            Nov 11, 2009          MPI_Add_error_string(3)

« Return to documentation listing