MPIAdderrorcode(3OpenMPI) MPIAdderrorcode(3OpenMPI)

NAME
       MMPPIIAAddddeerrrroorrccooddee  -  Creates  a new error code associated with error-
       class


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIAdderrorcode(int errorclass, int *errorcode)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPIADDERRORCODE(ERRORCLASS, ERRORCODE, IERROR)
            INTEGER  ERRORCLASS, ERRORCODE, IERROR


CC++++ SSyynnttaaxx
       #include 
       int MPI::Adderrorcode(int errorclass, int* errorcode)


IINNPPUUTT PPAARRAAMMEETTEERR
       errorclass    MPI error class (integer).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       errorcode     Error code returned by an MPI routine  or  an  MPI  error
                     class (integer).

       IERROR        Fortran only: Error status (integer).


DESCRIPTION
       Creates  a  new  error  code associated with errorclass and returns its
       value in errorcode.


NNOOTTEESS
       No function is provided to free error codes, as it is not expected that
       an application will create them in significant numbers.

       The value returned is always greater than or equal to MPIERRLASTCODE.


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
       MPIErrorclass





Open MPI 1.2                    September 2006    MPIAdderrorcode(3OpenMPI)