source: proiecte/hpl/openmpi_compiled/share/man/man3/MPI_Comm_get_errhandler.3 @ 97

Last change on this file since 97 was 97, checked in by (none), 14 years ago

Adding compiled files

File size: 1.8 KB
Line 
1.\"Copyright 2006-2008 Sun Microsystems, Inc.
2.\" Copyright (c) 1996 Thinking Machines Corporation
3.TH MPI_Comm_get_errhandler 3 "Dec 08, 2009" "1.4" "Open MPI"
4.SH NAME
5\fBMPI_Comm_get_errhandler \fP \- Retrieves error handler associated with a communicator.
6
7.SH SYNTAX
8.ft R
9.SH C Syntax
10.nf
11#include <mpi.h>
12int MPI_Comm_get_errhandler(MPI_Comm \fIcomm\fP,
13        MPI_Errhandler *\fIerrhandler\fP)
14
15.SH Fortran Syntax
16.nf
17INCLUDE 'mpif.h'
18MPI_COMM_GET_ERRHANDLER(\fICOMM, ERRHANDLER, IERROR\fP)
19        INTEGER \fICOMM, ERRHANDLER, IERROR\fP
20
21.SH C++ Syntax
22.nf
23#include <mpi.h>
24MPI::Errhandler MPI::Comm::Get_errhandler() const
25
26.SH INPUT PARAMETER
27.ft R
28.TP 1i
29comm
30Communicator (handle).
31
32.SH OUTPUT PARAMETERS
33.ft R
34.TP 1i
35errhandler
36New error handler for communicator (handle).
37.ft R
38.TP 1i
39IERROR
40Fortran only: Error status (integer).
41
42.SH DESCRIPTION
43.ft R
44MPI_Comm_get_errhandler retrieves the error handler currently associated with a communicator. This call is identical to MPI_Errhandler_get, the use of which is deprecated.
45
46.SH ERRORS
47Almost 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.
48.sp
49Before the error value is returned, the current MPI error handler is
50called. 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. 
51.sp
52See the MPI man page for a full list of MPI error codes.
53
54
Note: See TracBrowser for help on using the repository browser.