Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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_Errhandler_set(3)							MPI						     MPI_Errhandler_set(3)

NAME
MPI_Errhandler_set - Sets the error handler for a communicator SYNOPSIS
int MPI_Errhandler_set(MPI_Comm comm, MPI_Errhandler errhandler) INPUT PARAMETERS
comm - communicator to set the error handler for (handle) errhandler - new MPI error handler for communicator (handle) THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be safely used by multiple threads without the need for any user-provided thread locks. However, the routine is not interrupt safe. Typically, this is due to the use of memory allocation routines such as malloc or other non-MPICH runtime routines that are themselves not interrupt-safe. DEPRECATED FUNCTION
The MPI-2 standard deprecated a number of routines because MPI-2 provides better versions. This routine is one of those that was depre- cated. The routine may continue to be used, but new code should use the replacement routine. The replacement for this routine is MPI_Comm_set_errhandler . NOTES FOR FORTRAN
All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have an additional argument ierr at the end of the argument list. ierr is an integer and has the same meaning as the return value of the routine in C. In Fortran, MPI routines are subroutines, and are invoked with the call statement. All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in Fortran. ERRORS
All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error value; C routines as the value of the function and Fortran routines in the last argument. Before the value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job. The error handler may be changed with MPI_Comm_set_errhandler (for communicators), MPI_File_set_errhandler (for files), and MPI_Win_set_errhandler (for RMA windows). The MPI-1 routine MPI_Errhandler_set may be used but its use is deprecated. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarentee that an MPI program can continue past an error; however, MPI implementations will attempt to continue whenever possible. MPI_SUCCESS - No error; MPI routine completed successfully. MPI_ERR_COMM - Invalid communicator. A common error is to use a null communicator in a call (not even allowed in MPI_Comm_rank ). MPI_ERR_ARG - Invalid argument. Some argument is invalid and is not identified by a specific error class (e.g., MPI_ERR_RANK ). SEE ALSO
MPI_Comm_set_errhandler, MPI_Errhandler_create, MPI_Comm_create_errhandler LOCATION
errhandler_set.c 7/28/2010 MPI_Errhandler_set(3)
Man Page