MPIAdderrorstring(3OpenMPI) MPIAdderrorstring(3OpenMPI)

NAME
       MMPPIIAAddddeerrrroorrssttrriinngg - Associates a string with an error code or class


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIAdderrorstring(int errorcode, char *string)


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


CC++++ SSyynnttaaxx
       #include 
       void MPI::Adderrorstring(int errorcode, const char* string)


IINNPPUUTT PPAARRAAMMEETTEERRSS
       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
                     (string).


OOUUTTPPUUTT PPAARRAAMMEETTEERR
       IERROR        Fortran only: Error status (integer).


DESCRIPTION
       This  routine  associates  an error string with an error code or class.
       Calling MPIAdderrorstring 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 MPIAdderrorstring for  an  error  value
       not  generated  via MPIAdderrorclass or MPIAdderrorcode (e.g., an
       error code or class with a value not greater than MPILASTERRCODE).


EERRRROORRSS
       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::ERRORSTHROWEXCEPTIONS, 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
       MPICommseterrhandler; the predefined error handler MPIERRORSRETURN
       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
       MPIAdderrorclass
       MPIAdderrorcode
       MPIErrorclass
       MPIErrorstring





Open MPI 1.2                    September 2006  MPIAdderrorstring(3OpenMPI)