mpi_errhandler_create(3openmpi) [osx man page]

MPI_Errhandler_create(3OpenMPI) 										   MPI_Errhandler_create(3OpenMPI)

NAME

       MPI_Errhandler_create  - Creates an MPI-style error handler -- use of this routine is deprecated.

SYNTAX

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

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

INPUT PARAMETER

       function  User-defined error handling procedure.

OUTPUT PARAMETERS

       errhandler
		 MPI error handler (handle).

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       Note that use of this routine is deprecated as of MPI-2. Please use MPI_Comm_create_errhandler instead.

       This deprecated routine is not available in C++.

       Registers  the  user  routine function for use as an MPI exception handler. Returns in errhandler a handle to the registered exception han-
       dler.

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

	   typedef void (MPI_Handler_function)(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. If the
       routine would have returned MPI_ERR_IN_STATUS, it is the error code returned in the status for the request that caused the error handler to
       be invoked. The remaining arguments are stdargs arguments whose number and meaning is implementation-dependent.	An  implementation  should
       clearly document these arguments. Addresses are used so that the handler may be written in Fortran.

NOTE

       The  MPI-1  Standard  states that an implementation may make the output value (errhandler) simply the address of the function. However, the
       action of MPI_Errhandler_ free makes this impossible, since it is required to set the value of  the  argument  to  MPI_ERRHANDLER_NULL.	In
       addition, the actual error handler must remain until all communicators that use it are freed.

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_Comm_create_errhandler
       MPI_Comm_get_errhandler
       MPI_Comm_set_errhandler

Open MPI 1.2							  September 2006				   MPI_Errhandler_create(3OpenMPI)

Check Out this Related Man Page

MPI_File_create_errhandler(3OpenMPI)									      MPI_File_create_errhandler(3OpenMPI)

NAME

       MPI_File_create_errhandler  - Creates an MPI-style error handler that can be attached to a file.

SYNTAX

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

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

C++ Syntax
       #include <mpi.h> static MPI::Errhandler	    MPI::File::Create_errhandler(MPI::File::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

       Registers  the  user  routine function for use as an MPI exception handler. Returns in errhandler a handle to the registered exception han-
       dler.

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

	   typedef void (MPI_File_errhandler_fn)(MPI_File *, int *,
	   ...);

       The first argument to function is the file in use. The second is the error code to be returned by the MPI routine that raised the error.

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

	   SUBROUTINE FILE_ERRHANDLER_FN(FILE, ERROR_CODE, ...)
	       INTEGER FILE, ERROR_CODE

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

	   typedef void MPI::File::Errhandler_fn(MPI::File &, 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. For MPI I/O function errors, the default error handler is  set
       to  MPI_ERRORS_RETURN. The error handler may be changed with MPI_File_set_errhandler; the predefined error handler MPI_ERRORS_ARE_FATAL may
       be used to make I/O errors fatal. Note that MPI does not guarantee that an MPI program can continue past an error.

Open MPI 1.2							  September 2006			      MPI_File_create_errhandler(3OpenMPI)

Linux and UNIX Man Pages

mpi_errhandler_create(3openmpi) [osx man page]

Check Out this Related Man Page