1MPI_Errhandler_free(3) LAM/MPI MPI_Errhandler_free(3)
2
6 MPI_Errhandler_free - Frees an MPI-style errorhandler
7
9 #include <mpi.h>
10 int MPI_Errhandler_free(MPI_Errhandler* errhdl)
11
13 errhandler
14 - MPI error handler (handle). Set to MPI_ERRHANDLER_NULL on
15 exit.
16
19 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
20 an additional argument ierr at the end of the argument list. ierr is
21 an integer and has the same meaning as the return value of the routine
22 in C. In Fortran, MPI routines are subroutines, and are invoked with
23 the call statement.
24 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
26 Fortran.
27
30 If an error occurs in an MPI function, the current MPI error handler is
31 called to handle it. By default, this error handler aborts the MPI
32 job. The error handler may be changed with MPI_Errhandler_set ; the
33 predefined error handler MPI_ERRORS_RETURN may be used to cause error
34 values to be returned (in C and Fortran; this error handler is less
35 useful in with the C++ MPI bindings. The predefined error handler
36 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
37 needs to be recovered). Note that MPI does not guarantee that an MPI
38 program can continue past an error.
39 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
41 value; C routines as the value of the function and Fortran routines in
42 the last argument. The C++ bindings for MPI do not return error val‐
43 ues; instead, error values are communicated by throwing exceptions of
44 type MPI::Exception (but not by default). Exceptions are only thrown
45 if the error value is not MPI::SUCCESS .
46 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
49 functions will return upon an error, there will be no way to recover
50 what the actual error value was.
51 MPI_SUCCESS
52 - No error; MPI routine completed successfully.
53 MPI_ERR_ARG
54 - Invalid argument. Some argument is invalid and is not identi‐
55 fied by a specific error class. This is typically a NULL
56 pointer or other such error.
57
60 For more information, please see the official MPI Forum web site, which
61 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
62 ments contain detailed information about each MPI function (most of
63 which is not duplicated in these man pages).
64 http://www.mpi-forum.org/
66
70 The LAM Team would like the thank the MPICH Team for the handy program
71 to generate man pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sow‐
72 ing/sowing.tar.gz ), the initial formatting, and some initial text for
73 most of the MPI-1 man pages.
74
76 errfree.c
77LAM/MPI 7.1.2 2/23/2006 MPI_Errhandler_free(3)