mpi_comm_create_errhandler(3openmpi) [osx man page]

MPI_Comm_create_errhandler(3OpenMPI)									      MPI_Comm_create_errhandler(3OpenMPI)

NAME

       MPI_Comm_create_errhandler  - Creates an error handler that can be attached to communicators.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Comm_create_errhandler(MPI_Comm_errhandler_fn *function,
	    MPI_Errhandler *errhandler)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_COMM_CREATE_ERRHANDLER(FUNCTION, ERRHANDLER, IERROR)
	    EXTERNAL  FUNCTION
	    INTEGER   ERRHANDLER, IERROR

C++ Syntax
       #include <mpi.h>
       static MPI::Errhandler
	    MPI::Comm::Create_errhandler(MPI::Comm::Errhandler_fn*
	    function)

INPUT PARAMETER

       function  User-defined error handling procedure (function).

OUTPUT PARAMETERS

       errhandler
		 MPI error handler (handle).

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       MPI_Comm_create_errhandler  creates  an	error  handler	that  can  be attached to communicators. This function is identical to MPI_Errhan-
       dler_create, the use of which is deprecated.

       In C, the user routine should be a function of type MPI_Comm_errhandler_fn, which is defined as

	   typedef void MPI_Comm_errhandler_fn(MPI_Comm *, int *, ...);

       The first argument is the communicator in use. The second is the error code to be returned by the MPI routine that raised the  error.  This
       typedef replaces MPI_Handler_function, the use of which is deprecated.

       In Fortran, the user routine should be of this form:

	   SUBROUTINE COMM_ERRHANDLER_FN(COMM, ERROR_CODE, ...)
	       INTEGER COMM, ERROR_CODE

       In C++, the user routine should be of this form:

	   typedef void MPI::Comm::Errhandler_fn(MPI_Comm &, int *, ...);

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++ 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 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.

Open MPI 1.2							  September 2006			      MPI_Comm_create_errhandler(3OpenMPI)

Check Out this Related Man Page

MPI_Add_error_code(3OpenMPI)											      MPI_Add_error_code(3OpenMPI)

NAME

       MPI_Add_error_code - Creates a new error code associated with errorclass

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Add_error_code(int errorclass, int *errorcode)

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

C++ Syntax
       #include <mpi.h>
       int MPI::Add_error_code(int errorclass, int* errorcode)

INPUT PARAMETER

       errorclass    MPI error class (integer).

OUTPUT PARAMETERS

       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.

NOTES

       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 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++ 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 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_class
       MPI_Error_class

Open MPI 1.2							  September 2006				      MPI_Add_error_code(3OpenMPI)

Linux and UNIX Man Pages

mpi_comm_create_errhandler(3openmpi) [osx man page]

Check Out this Related Man Page