1MPI_Comm_create_keyval(3) LAM/MPI MPI_Comm_create_keyval(3)
2
6 MPI_Comm_create_keyval - Create a communicator attribute key
7
9 #include <mpi.h>
10 int
11 MPI_Comm_create_keyval(MPI_Comm_copy_attr_function *cpyfunc,
12 MPI_Comm_delete_attr_function *delfunc,
13 int *key, void *extra)
14
16 cpyfunc
17 - Copy callback function for comm_keyval
18 delfunc
19 - Delete callback function for comm_keyval
20 extra - Extra status info
21
24 key - Key value for future access
25
28 The IMPI standard only supports MPI-1 functions. Hence, this function
29 is currently not designed to operate within an IMPI job.
30
33 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
34 an additional argument ierr at the end of the argument list. ierr is
35 an integer and has the same meaning as the return value of the routine
36 in C. In Fortran, MPI routines are subroutines, and are invoked with
37 the call statement.
38 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
40 Fortran.
41
44 If an error occurs in an MPI function, the current MPI error handler is
45 called to handle it. By default, this error handler aborts the MPI
46 job. The error handler may be changed with MPI_Errhandler_set ; the
47 predefined error handler MPI_ERRORS_RETURN may be used to cause error
48 values to be returned (in C and Fortran; this error handler is less
49 useful in with the C++ MPI bindings. The predefined error handler
50 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
51 needs to be recovered). Note that MPI does not guarantee that an MPI
52 program can continue past an error.
53 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
55 value; C routines as the value of the function and Fortran routines in
56 the last argument. The C++ bindings for MPI do not return error val‐
57 ues; instead, error values are communicated by throwing exceptions of
58 type MPI::Exception (but not by default). Exceptions are only thrown
59 if the error value is not MPI::SUCCESS .
60 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
63 functions will return upon an error, there will be no way to recover
64 what the actual error value was.
65 MPI_SUCCESS
66 - No error; MPI routine completed successfully.
67
70 MPI_Comm_free_keyval(3), MPI_Comm_set_attr(3), MPI_Comm_get_attr(3),
71 MPI_Comm_delete_attr(3)
72
75 For more information, please see the official MPI Forum web site, which
76 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
77 ments contain detailed information about each MPI function (most of
78 which is not duplicated in these man pages).
79 http://www.mpi-forum.org/
81
83 ccreatekey.c
84LAM/MPI 7.1.2 2/23/2006 MPI_Comm_create_keyval(3)