1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Comm_call_errhandler 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | |
---|
6 | \fBMPI_Comm_call_errhandler\fP \- Passes the supplied error code to the |
---|
7 | error handler assigned to a communicator |
---|
8 | |
---|
9 | .SH SYNTAX |
---|
10 | .ft R |
---|
11 | |
---|
12 | .SH C Syntax |
---|
13 | .nf |
---|
14 | #include <mpi.h> |
---|
15 | int MPI_Comm_call_errhandler(MPI_Comm \fIcomm\fP, int \fIerrorcode\fP) |
---|
16 | |
---|
17 | .SH Fortran Syntax |
---|
18 | .nf |
---|
19 | INCLUDE 'mpif.h' |
---|
20 | MPI_COMM_CALL_ERRHANDLER(\fICOMM, ERRORCODE, IERROR\fP) |
---|
21 | INTEGER \fICOMM, ERRORCODE, IERROR\fP |
---|
22 | |
---|
23 | .SH C++ Syntax |
---|
24 | .nf |
---|
25 | #include <mpi.h> |
---|
26 | void MPI::Comm::Call_errhandler(int \fIerrorcode\fP) const |
---|
27 | |
---|
28 | .SH INPUT PARAMETER |
---|
29 | .ft R |
---|
30 | .TP 1.4i |
---|
31 | comm |
---|
32 | communicator with error handler (handle). |
---|
33 | .ft R |
---|
34 | .TP 1.4i |
---|
35 | errorcode |
---|
36 | error code (integer). |
---|
37 | |
---|
38 | .SH OUTPUT PARAMETERS |
---|
39 | .ft R |
---|
40 | .TP 1.4i |
---|
41 | IERROR |
---|
42 | Fortran only: Error status (integer). |
---|
43 | |
---|
44 | .SH DESCRIPTION |
---|
45 | .ft R |
---|
46 | This function invokes the error handler assigned to the communicator |
---|
47 | \fIcomm\fP with the supplied error code \fIerrorcode\fP. If the error |
---|
48 | handler was successfully called, the process is not aborted, and the |
---|
49 | error handler returns, this function returns MPI_SUCCESS. |
---|
50 | |
---|
51 | .SH NOTES |
---|
52 | .ft R |
---|
53 | Users should note that the default error handler is |
---|
54 | MPI_ERRORS_ARE_FATAL. Thus, calling this function will abort the |
---|
55 | processes in \fIcomm\fP if the default error handler has not been |
---|
56 | changed. |
---|
57 | |
---|
58 | .SH ERRORS |
---|
59 | .ft R |
---|
60 | Almost all MPI routines return an error value; C routines as |
---|
61 | the value of the function and Fortran routines in the last argument. C++ |
---|
62 | functions do not return errors. If the default error handler is set to |
---|
63 | MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism |
---|
64 | will be used to throw an MPI:Exception object. |
---|
65 | .sp |
---|
66 | See the MPI man page for a full list of MPI error codes. |
---|
67 | |
---|
68 | .SH SEE ALSO |
---|
69 | .ft R |
---|
70 | .nf |
---|
71 | MPI_Comm_create_errhandler |
---|
72 | MPI_Comm_set_errhandler |
---|
73 | |
---|