1MPI_Info_get(3) LAM/MPI MPI_Info_get(3)
2
6 MPI_Info_get - Get a (key, value) pair from an MPI_Info object
7
9 #include <mpi.h>
10 int MPI_Info_get(MPI_Info info, char *key,
11 int valuelen, char *value, int *flag)
12
14 info - info object (handle)
15 key - null-terminated character string of the index key
16 valuelen
17 - maximum length of value (integer)
18
21 value - null-terminated character string of the value
22 flag - true (1) if key defined on info , false (0) if not (logical)
23
26 In C and C++, valuelen should be one less than the allocated space to
27 allow for for the null terminator.
28
31 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
32 an additional argument ierr at the end of the argument list. ierr is
33 an integer and has the same meaning as the return value of the routine
34 in C. In Fortran, MPI routines are subroutines, and are invoked with
35 the call statement.
36 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
38 Fortran.
39
42 If an error occurs in an MPI function, the current MPI error handler is
43 called to handle it. By default, this error handler aborts the MPI
44 job. The error handler may be changed with MPI_Errhandler_set ; the
45 predefined error handler MPI_ERRORS_RETURN may be used to cause error
46 values to be returned (in C and Fortran; this error handler is less
47 useful in with the C++ MPI bindings. The predefined error handler
48 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
49 needs to be recovered). Note that MPI does not guarantee that an MPI
50 program can continue past an error.
51 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
53 value; C routines as the value of the function and Fortran routines in
54 the last argument. The C++ bindings for MPI do not return error val‐
55 ues; instead, error values are communicated by throwing exceptions of
56 type MPI::Exception (but not by default). Exceptions are only thrown
57 if the error value is not MPI::SUCCESS .
58 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
61 functions will return upon an error, there will be no way to recover
62 what the actual error value was.
63 MPI_SUCCESS
64 - No error; MPI routine completed successfully.
65 MPI_ERR_ARG
66 - Invalid argument. Some argument is invalid and is not identi‐
67 fied by a specific error class. This is typically a NULL
68 pointer or other such error.
69 MPI_INFO_KEY
70 - This error class is associated with an error code that indi‐
71 cates that a null key, empty key, or key that was longer than
72 MPI_MAX_INFO_KEY characters was passed as an argument to an MPI
73 function where it was not allowed.
74
77 For more information, please see the official MPI Forum web site, which
78 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
79 ments contain detailed information about each MPI function (most of
80 which is not duplicated in these man pages).
81 http://www.mpi-forum.org/
83
85 infoget.c
86LAM/MPI 7.1.2 2/23/2006 MPI_Info_get(3)