MPI_Add_error_class(3)             Open MPI             MPI_Add_error_class(3)



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


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


Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_ADD_ERROR_CLASS(ERRORCLASS, IERROR)
            INTEGER   ERRORCLASS, IERROR


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


OUTPUT PARAMETERS
       errorclass    New error class (integer).

       IERROR        Fortran only: Error status (integer).


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


NOTES
       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
       potential for confusion, MPI_Add_error_string may be used on multiple
       processes to associate the same error string with the newly created
       errorclass. 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.


ERRORS
       Almost all MPI routines return an error value; C routines as the value
       of the function and Fortran routines in the last argument. C++
       functions 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.


SEE ALSO
       MPI_Add_error_code
       MPI_Add_error_string
       MPI_Error_class
       MPI_Error_string




1.4.1                            Jan 14, 2010           MPI_Add_error_class(3)
