[97] | 1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
| 2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
| 3 | .TH MPI_Add_error_class 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
| 4 | |
---|
| 5 | .SH NAME |
---|
| 6 | .nf |
---|
| 7 | \fBMPI_Add_error_class\fP \- Creates a new error class and returns its value |
---|
| 8 | |
---|
| 9 | .SH SYNTAX |
---|
| 10 | .ft R |
---|
| 11 | |
---|
| 12 | .SH C Syntax |
---|
| 13 | .nf |
---|
| 14 | #include <mpi.h> |
---|
| 15 | int MPI_Add_error_class(int *\fIerrorclass\fP) |
---|
| 16 | |
---|
| 17 | .SH Fortran Syntax |
---|
| 18 | .nf |
---|
| 19 | INCLUDE 'mpif.h' |
---|
| 20 | MPI_ADD_ERROR_CLASS(\fIERRORCLASS, IERROR\fP) |
---|
| 21 | INTEGER \fIERRORCLASS, IERROR\fP |
---|
| 22 | |
---|
| 23 | .SH C++ Syntax |
---|
| 24 | .nf |
---|
| 25 | #include <mpi.h> |
---|
| 26 | int MPI::Add_error_class() |
---|
| 27 | |
---|
| 28 | .SH OUTPUT PARAMETERS |
---|
| 29 | .ft R |
---|
| 30 | .TP 1.4i |
---|
| 31 | errorclass |
---|
| 32 | New error class (integer). |
---|
| 33 | .ft R |
---|
| 34 | .TP 1.4i |
---|
| 35 | IERROR |
---|
| 36 | Fortran only: Error status (integer). |
---|
| 37 | |
---|
| 38 | .SH DESCRIPTION |
---|
| 39 | .ft R |
---|
| 40 | The function MPI_Add_error_class creates a new, local error |
---|
| 41 | class. |
---|
| 42 | |
---|
| 43 | .SH NOTES |
---|
| 44 | .ft R |
---|
| 45 | Because this function is local, the same value of \fIerrorclass\fP may |
---|
| 46 | not be returned on all processes that make this call, even if they |
---|
| 47 | call the function concurrently. Thus, same error on different |
---|
| 48 | processes may not cause the same value of \fIerrorclass\fP to be |
---|
| 49 | returned. To reduce the potential for confusion, MPI_Add_error_string |
---|
| 50 | may be used on multiple processes to associate the same error string |
---|
| 51 | with the newly created \fIerrorclass\fP. Even though \fIerrorclass\fP |
---|
| 52 | may not be consistent across processes, using MPI_Add_error_string |
---|
| 53 | will ensure the error string associated with it will be the same |
---|
| 54 | everywhere. |
---|
| 55 | .sp |
---|
| 56 | No function is provided to free error classes, as it is not expected |
---|
| 57 | that an application will create them in significant numbers. |
---|
| 58 | .sp |
---|
| 59 | The value returned is always greater than or equal to MPI_ERR_LASTCODE. |
---|
| 60 | |
---|
| 61 | .SH ERRORS |
---|
| 62 | .ft R |
---|
| 63 | Almost all MPI routines return an error value; C routines as |
---|
| 64 | the value of the function and Fortran routines in the last argument. C++ |
---|
| 65 | functions do not return errors. If the default error handler is set to |
---|
| 66 | MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism |
---|
| 67 | will be used to throw an MPI:Exception object. |
---|
| 68 | .sp |
---|
| 69 | Before the error value is returned, the current MPI error handler is |
---|
| 70 | called. By default, this error handler aborts the MPI job, except for |
---|
| 71 | I/O function errors. The error handler may be changed with |
---|
| 72 | MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN |
---|
| 73 | may be used to cause error values to be returned. Note that MPI does not |
---|
| 74 | guarantee that an MPI program can continue past an error. |
---|
| 75 | |
---|
| 76 | .SH SEE ALSO |
---|
| 77 | .ft R |
---|
| 78 | .nf |
---|
| 79 | MPI_Add_error_code |
---|
| 80 | MPI_Add_error_string |
---|
| 81 | MPI_Error_class |
---|
| 82 | MPI_Error_string |
---|
| 83 | |
---|