Lockless Inc


MPI_Errhandler_set - Sets the error handler for a communicator


#include <mpi.h> int MPI_Errhandler_set(MPI_Comm comm , MPI_Errhandler errh );

#include <pmpi.h> int PMPI_Errhandler_set(MPI_Comm comm , MPI_Errhandler errh );

#include <mpi.h> void MPI::Comm::Set_errhandler(const Errhandler &errh ) const;

INCLUDE 'mpif.h' MPI_ERRHANDLER_SET(comm , errh , ierr ) INTEGER comm , errh , ierr


comm - intracommunicator (handle)

errh - error handler handle (handle)


The MPI_Errhandler_set() function is used to set the error handler (sepcified by the handle errh ) for a communicator comm . When there is an error in an MPI function using the communicator comm , the error handler will be invoked.

Note that some MPI functions do not use a communicator as an argument. Those functions will use the error handler of MPI_COMM_WORLD. Also, the error handler for MPI_COMM_WORLD will be invoked if the communicator passed to an MPI function is invalid.

Use the MPI_Errhandler_get() function to obtain the current handler for a communicator. If a communicator is duplicated, then the new communicator will inherit its error handler.

The C++ member function is marked const even though it modifies the underlying object to allow you to change the error handler of the default communicators MPI_COMM_WORLD and MPI_COMM_SELF.

The communicator must be a valid one (not MPI_COMM_NULL). PMPI_Errhandler_set() is the profiling version of this function.


All MPI routines except for MPI_Wtime and MPI_Wtick return an error code. The the current MPI error handler is invoked if the return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable.

In C, the error code is passed as the return value. In FORTRAN, all functions have an parameter ierr which returns the error code. MPI C++ functions do not directly return an error code. However, C++ users may want to use the MPI::ERRORS_THROW_EXCEPTIONS handler. This will throw an MPI::Exception with the corresponding error code. To prevent exceptions from being raised from within C and Fortran code, they will see all error return values as MPI_ERR_PENDING when this handler is chosen. In this implementation, call MPI::throw_exception() to throw the correct exception if this occurs.

MPI_SUCCESS - No error;

MPI_ERR_PENDING - Pending exception;

MPI_ERR_COMM - Invalid communicator;

MPI_ERR_ARG - Invalid error handler.


MPI_Errhandler_create (3) MPI_Errhandler_free (3) MPI_Errhandler_get (3) MPI_Error_string (3) MPI_Error_class (3)

About Us Returns Policy Privacy Policy Send us Feedback
Company Info | Product Index | Category Index | Help | Terms of Use
Copyright © Lockless Inc All Rights Reserved.