1
1
openmpi/ompi/mpi/man/man3/MPI_Comm_set_errhandler.3
Karen Norteman 59cc09fd1a Fixes trac:850, updates man pages
This commit was SVN r13456.

The following Trac tickets were found above:
  Ticket 850 --> https://svn.open-mpi.org/trac/ompi/ticket/850
2007-02-01 21:57:48 +00:00

53 строки
1.9 KiB
Groff

.\"Copyright 2006, Sun Microsystems, Inc.
.\" Copyright (c) 1996 Thinking Machines Corporation
.TH MPI_Comm_set_errhandler 3OpenMPI "September 2006" "Open MPI 1.2" " "
.SH NAME
\fBMPI_Comm_set_errhandler \fP \- Attaches a new error handler to a communicator.
.SH SYNTAX
.ft R
.SH C Syntax
.nf
#include <mpi.h>
int MPI_Comm_set_errhandler(MPI_Comm \fIcomm\fP,
MPI_Errhandler \fIerrhandler\fP)
.SH Fortran Syntax
.nf
INCLUDE 'mpif.h'
MPI_COMM_SET_ERRHANDLER(\fICOMM, ERRHANDLER, IERROR\fP)
INTEGER \fICOMM, ERRHANDLER, IERROR\fP
.SH C++ Syntax
.nf
#include <mpi.h>
void MPI::Comm::Set_errhandler(const MPI::Errhandler& \fIerrhandler\fP)
.SH INPUT/OUTPUT PARAMETER
.ft R
.TP 1i
comm
Communicator (handle).
.SH OUTPUT PARAMETERS
.ft R
.TP 1i
errhandler
New error handler for communicator (handle).
.ft R
.TP 1i
IERROR
Fortran only: Error status (integer).
.SH DESCRIPTION
.ft R
MPI_Comm_set_errhandler attaches a new error handler to a communicator. The error handler must be either a predefined error handler or an error handler created by a call to MPI_Comm_create_errhandler. This call is identical to MPI_Errhandler_set, the use of which is deprecated.
.SH 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.
.sp
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.
' @(#)MPI_Comm_set_errhandler.3 1.18 06/03/09