Line | |
---|
1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_File_set_errhandler 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_File_set_errhandler \fP \- Sets the error handler for a file. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_File_set_errhandler(MPI_File \fIfile\fP, MPI_Errhandler |
---|
13 | \fIerrhandler\fP) |
---|
14 | |
---|
15 | .SH Fortran Syntax |
---|
16 | .nf |
---|
17 | INCLUDE 'mpif.h' |
---|
18 | MPI_FILE_SET_ERRHANDLER(\fIFILE, ERRHANDLER, IERROR\fP) |
---|
19 | INTEGER \fIFILE, ERRHANDLER, IERROR\fP |
---|
20 | |
---|
21 | .SH C++ Syntax |
---|
22 | .nf |
---|
23 | #include <mpi.h> |
---|
24 | void MPI::File::Set_errhandler(const MPI::Errhandler& \fIerrhandler\fP) |
---|
25 | |
---|
26 | .SH INPUT/OUTPUT PARAMETER |
---|
27 | .ft R |
---|
28 | .TP 1i |
---|
29 | file |
---|
30 | File (handle). |
---|
31 | |
---|
32 | .SH INPUT PARAMETER |
---|
33 | .ft R |
---|
34 | .TP 1i |
---|
35 | errhandler |
---|
36 | New error handler for file (handle). |
---|
37 | |
---|
38 | .SH OUTPUT PARAMETER |
---|
39 | .ft R |
---|
40 | .TP 1i |
---|
41 | IERROR |
---|
42 | Fortran only: Error status (integer). |
---|
43 | |
---|
44 | .SH DESCRIPTION |
---|
45 | .ft R |
---|
46 | Attaches a new error handler to a file. The error handler must be either a predefined error handler or an error handler created by a call to MPI_File_create_errhandler. |
---|
47 | |
---|
48 | .SH ERRORS |
---|
49 | 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. |
---|
50 | .sp |
---|
51 | Before the error value is returned, the current MPI error handler is |
---|
52 | called. For MPI I/O function errors, the default error handler is set to MPI_ERRORS_RETURN. The error handler may be changed with MPI_File_set_errhandler; the predefined error handler MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI does not guarantee that an MPI program can continue past an error. |
---|
53 | |
---|
54 | |
---|
Note: See
TracBrowser
for help on using the repository browser.