1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Add_error_string 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | |
---|
5 | .SH NAME |
---|
6 | .nf |
---|
7 | \fBMPI_Add_error_string\fP \- Associates a string with an error code or class |
---|
8 | |
---|
9 | .SH SYNTAX |
---|
10 | .ft R |
---|
11 | |
---|
12 | .SH C Syntax |
---|
13 | .nf |
---|
14 | #include <mpi.h> |
---|
15 | int MPI_Add_error_string(int \fIerrorcode\fP, char *\fIstring\fP) |
---|
16 | |
---|
17 | .SH Fortran Syntax |
---|
18 | .nf |
---|
19 | INCLUDE 'mpif.h' |
---|
20 | MPI_ADD_ERROR_STRING(\fIERRORCODE, STRING, IERROR\fP) |
---|
21 | INTEGER \fIERRORCODE, IERROR\fP |
---|
22 | CHARACTER*(*) \fISTRING\fP |
---|
23 | |
---|
24 | .SH C++ Syntax |
---|
25 | .nf |
---|
26 | #include <mpi.h> |
---|
27 | void MPI::Add_error_string(int \fIerrorcode\fP, const char* \fIstring\fP) |
---|
28 | |
---|
29 | .SH INPUT PARAMETERS |
---|
30 | .ft R |
---|
31 | .TP 1.4i |
---|
32 | errorcode |
---|
33 | MPI error class, or an error code returned by an MPI routine (integer). |
---|
34 | .ft R |
---|
35 | .TP 1.4i |
---|
36 | string |
---|
37 | Text that corresponds to the error code or class (string). |
---|
38 | |
---|
39 | .SH OUTPUT PARAMETER |
---|
40 | .ft R |
---|
41 | .TP 1.4i |
---|
42 | IERROR |
---|
43 | Fortran only: Error status (integer). |
---|
44 | |
---|
45 | .SH DESCRIPTION |
---|
46 | .ft R |
---|
47 | This routine associates an error string with an error code or |
---|
48 | class. Calling MPI_Add_error_string for an error code or class that |
---|
49 | already has an associated error string will replace the old string |
---|
50 | with the new one. It is erroneous to call MPI_Add_error_string for an |
---|
51 | error value not generated via MPI_Add_error_class or |
---|
52 | MPI_Add_error_code (e.g., an error code or class with a value not |
---|
53 | greater than MPI_LAST_ERRCODE). |
---|
54 | |
---|
55 | .SH ERRORS |
---|
56 | .ft R |
---|
57 | Almost all MPI routines return an error value; C routines as |
---|
58 | the value of the function and Fortran routines in the last argument. C++ |
---|
59 | functions do not return errors. If the default error handler is set to |
---|
60 | MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism |
---|
61 | will be used to throw an MPI:Exception object. |
---|
62 | .sp |
---|
63 | Before the error value is returned, the current MPI error handler is |
---|
64 | called. By default, this error handler aborts the MPI job, except for |
---|
65 | I/O function errors. The error handler may be changed with |
---|
66 | MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN |
---|
67 | may be used to cause error values to be returned. Note that MPI does not |
---|
68 | guarantee that an MPI program can continue past an error. |
---|
69 | |
---|
70 | .SH SEE ALSO |
---|
71 | .ft R |
---|
72 | .nf |
---|
73 | MPI_Add_error_class |
---|
74 | MPI_Add_error_code |
---|
75 | MPI_Error_class |
---|
76 | MPI_Error_string |
---|
77 | |
---|
78 | |
---|