1MPI_Error_string(3) LAM/MPI MPI_Error_string(3)
2
3
4
6 MPI_Error_string - Return a string for a given error code
7
9 #include <mpi.h>
10 int MPI_Error_string(int errcode, char *msg,
11 int *plen)
12
14 errcode
15 - Error code returned by an MPI routine or an MPI error class
16
17
19 msg - Text that corresponds to the errorcode
20 plen - Length of string
21
22
24 Error codes are the values return by MPI routines (in C) or in the ierr
25 argument (in Fortran). These can be converted into error classes with
26 the routine MPI_Error_class .
27
28
29 These messages are provided in English (En_US - English/United States).
30 If there is an interest in providing messages in different languages,
31 please submit requests to the LAM mailing list (see http://www.lam-
32 mpi.org/contact.php ).
33
34
36 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
37 an additional argument ierr at the end of the argument list. ierr is
38 an integer and has the same meaning as the return value of the routine
39 in C. In Fortran, MPI routines are subroutines, and are invoked with
40 the call statement.
41
42 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
43 Fortran.
44
45
47 For more information, please see the official MPI Forum web site, which
48 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
49 ments contain detailed information about each MPI function (most of
50 which is not duplicated in these man pages).
51
52 http://www.mpi-forum.org/
53
54
55
57 The LAM Team would like the thank the MPICH Team for the handy program
58 to generate man pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sow‐
59 ing/sowing.tar.gz ), the initial formatting, and some initial text for
60 most of the MPI-1 man pages.
61
63 errstring.c
64
65
66
67LAM/MPI 7.1.2 2/23/2006 MPI_Error_string(3)