1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Comm_create_errhandler 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Comm_create_errhandler \fP \- Creates an error handler that can be attached to communicators. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Comm_create_errhandler(MPI_Comm_errhandler_fn \fI*function\fP, |
---|
13 | MPI_Errhandler *\fIerrhandler\fP) |
---|
14 | |
---|
15 | .SH Fortran Syntax |
---|
16 | .nf |
---|
17 | INCLUDE 'mpif.h' |
---|
18 | MPI_COMM_CREATE_ERRHANDLER(\fIFUNCTION, ERRHANDLER, IERROR\fP) |
---|
19 | EXTERNAL \fIFUNCTION\fP |
---|
20 | INTEGER \fIERRHANDLER, IERROR\fP |
---|
21 | |
---|
22 | .SH C++ Syntax |
---|
23 | .nf |
---|
24 | #include <mpi.h> |
---|
25 | static MPI::Errhandler |
---|
26 | MPI::Comm::Create_errhandler(MPI::Comm::Errhandler_fn* |
---|
27 | \fIfunction\fP) |
---|
28 | |
---|
29 | .SH INPUT PARAMETER |
---|
30 | .ft R |
---|
31 | .TP 1i |
---|
32 | function |
---|
33 | User-defined error handling procedure (function). |
---|
34 | |
---|
35 | .SH OUTPUT PARAMETERS |
---|
36 | .ft R |
---|
37 | .TP 1i |
---|
38 | errhandler |
---|
39 | MPI error handler (handle). |
---|
40 | .ft R |
---|
41 | .TP 1i |
---|
42 | IERROR |
---|
43 | Fortran only: Error status (integer). |
---|
44 | |
---|
45 | .SH DESCRIPTION |
---|
46 | .ft R |
---|
47 | MPI_Comm_create_errhandler creates an error handler that can be attached to communicators. This function is identical to MPI_Errhandler_create, the use of which is deprecated. |
---|
48 | .sp |
---|
49 | In C, the user routine should be a function of type MPI_Comm_errhandler_fn, which is defined as |
---|
50 | .sp |
---|
51 | .nf |
---|
52 | typedef void MPI_Comm_errhandler_fn(MPI_Comm *, int *, \&...); |
---|
53 | .fi |
---|
54 | .sp |
---|
55 | The first argument is the communicator in use. The second is the error code |
---|
56 | to be returned by the MPI routine that raised the error. This typedef replaces MPI_Handler_function, the use of which is deprecated. |
---|
57 | .sp |
---|
58 | In Fortran, the user routine should be of this form: |
---|
59 | .sp |
---|
60 | .nf |
---|
61 | SUBROUTINE COMM_ERRHANDLER_FN(COMM, ERROR_CODE, \&...) |
---|
62 | INTEGER COMM, ERROR_CODE |
---|
63 | .fi |
---|
64 | .sp |
---|
65 | In C++, the user routine should be of this form: |
---|
66 | .sp |
---|
67 | .nf |
---|
68 | typedef void MPI::Comm::Errhandler_fn(MPI_Comm &, int *, \&...); |
---|
69 | .fi |
---|
70 | |
---|
71 | .SH ERRORS |
---|
72 | 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. |
---|
73 | .sp |
---|
74 | Before the error value is returned, the current MPI error handler is |
---|
75 | 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. |
---|
76 | |
---|
77 | |
---|
78 | |
---|