[97] | 1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
| 2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
| 3 | .TH MPI_File_call_errhandler 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
| 4 | |
---|
| 5 | .SH NAME |
---|
| 6 | \fBMPI_File_call_errhandler\fP \- Passes the supplied error code to the |
---|
| 7 | error handler assigned to a file |
---|
| 8 | |
---|
| 9 | .SH SYNTAX |
---|
| 10 | .ft R |
---|
| 11 | |
---|
| 12 | .SH C Syntax |
---|
| 13 | .nf |
---|
| 14 | #include <mpi.h> |
---|
| 15 | int MPI_File_call_errhandler(MPI_File \fIfh\fP, int \fIerrorcode\fP) |
---|
| 16 | |
---|
| 17 | .SH Fortran Syntax |
---|
| 18 | .nf |
---|
| 19 | INCLUDE 'mpif.h' |
---|
| 20 | MPI_FILE_CALL_ERRHANDLER(\fIFH, ERRORCODE, IERROR\fP) |
---|
| 21 | INTEGER \fIFH, IERRORCODE, IERROR\fP |
---|
| 22 | |
---|
| 23 | .SH C++ Syntax |
---|
| 24 | .nf |
---|
| 25 | #include <mpi.h> |
---|
| 26 | void MPI::File::Call_errhandler(int \fIerrorcode\fP) const |
---|
| 27 | |
---|
| 28 | .SH INPUT PARAMETERS |
---|
| 29 | .ft R |
---|
| 30 | .TP 1.4i |
---|
| 31 | fh |
---|
| 32 | file with error handler (handle). |
---|
| 33 | .ft R |
---|
| 34 | .TP 1.4i |
---|
| 35 | errorcode |
---|
| 36 | MPI error code (integer). |
---|
| 37 | |
---|
| 38 | .SH OUTPUT PARAMETER |
---|
| 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 file handle |
---|
| 47 | \fIfh\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 | .sp |
---|
| 51 | Unlike errors on communicators and windows, the default errorhandler |
---|
| 52 | for files is MPI_ERRORS_RETURN. |
---|
| 53 | |
---|
| 54 | .SH ERRORS |
---|
| 55 | .ft R |
---|
| 56 | Almost all MPI routines return an error value; C routines as |
---|
| 57 | the value of the function and Fortran routines in the last argument. C++ |
---|
| 58 | functions do not return errors. If the default error handler is set to |
---|
| 59 | MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism |
---|
| 60 | will be used to throw an MPI:Exception object. |
---|
| 61 | .sp |
---|
| 62 | See the MPI man page for a full list of MPI error codes. |
---|
| 63 | |
---|
| 64 | .SH SEE ALSO |
---|
| 65 | .ft R |
---|
| 66 | .nf |
---|
| 67 | MPI_File_create_errhandler |
---|
| 68 | MPI_File_set_errhandler |
---|
| 69 | |
---|