MPIAdderrorclass(3OpenMPI) MPIAdderrorclass(3OpenMPI)

NAME
       MMPPIIAAddddeerrrroorrccllaassss - Creates a new error class and returns its value


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIAdderrorclass(int *errorclass)


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


CC++++ SSyynnttaaxx
       #include 
       int MPI::Adderrorclass()


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       errorclass    New error class (integer).

       IERROR        Fortran only: Error status (integer).


DESCRIPTION
       The function MPIAdderrorclass creates a new, local error class.


NNOOTTEESS
       Because this function is local, the same value of errorclass may not be
       returned on all processes that make this call, even if  they  call  the
       function  concurrently. Thus, same error on different processes may not
       cause the same value of errorclass to be returned. To reduce the poten-
       tial  for  confusion, MPIAdderrorstring may be used on multiple pro-
       cesses to associate the same error string with the newly created error-
       class.  Even  though errorclass may not be consistent across processes,
       using MPIAdderrorstring will ensure the error string associated with
       it will be the same everywhere.

       No  function  is  provided to free error classes, 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
       MPIAdderrorcode
       MPIAdderrorstring
       MPIErrorclass
       MPIErrorstring




Open MPI 1.2                    September 2006   MPIAdderrorclass(3OpenMPI)