Open MPI logo

MPI_Add_error_class(3) man page (version 1.3.4)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing


       MPI_Add_error_class - Creates a new error class and returns its value


C Syntax

       #include <mpi.h>
       int MPI_Add_error_class(int *errorclass)

Fortran Syntax

       INCLUDE 'mpif.h'

C++ Syntax

       #include <mpi.h>
       int MPI::Add_error_class()


       errorclass    New error class (integer).

       IERROR        Fortran only: Error status (integer).


       The function MPI_Add_error_class creates a new, local error class.


       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, MPI_Add_error_string 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 MPI_Add_error_string 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 MPI_ERR_LASTCODE.


       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

1.3.4                            Nov 11, 2009           MPI_Add_error_class(3)

« Return to documentation listing