MPI_Win_create_keyval(3)

1MPI_Win_create_keyval(3)            LAM/MPI           MPI_Win_create_keyval(3)
2
3
4

NAME

6       MPI_Win_create_keyval -  Create a window attribute key
7

SYNOPSIS

9       #include <mpi.h>
10       int MPI_Win_create_keyval(MPI_Win_copy_attr_function *cpyfunc,
11                               MPI_Win_delete_attr_function *delfunc,
12                               int *key,
13                               void *extra)
14

INPUT PARAMETERS

16       cpyfunc
17              - copy callback function for win_keyval (function)
18       delfunc
19              - delete callback function for win_keyval (function)
20       extra  - extra state for callback functions
21
22

OUTPUT PARAMETER

24       key    - key value for future access (integer)
25
26

NOTES FOR FORTRAN

28       All  MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
29       an additional argument ierr at the end of the argument list.   ierr  is
30       an  integer and has the same meaning as the return value of the routine
31       in C.  In Fortran, MPI routines are subroutines, and are  invoked  with
32       the call statement.
33
34       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
35       Fortran.
36
37

ERRORS

39       If an error occurs in an MPI function, the current MPI error handler is
40       called  to  handle  it.   By default, this error handler aborts the MPI
41       job.  The error handler may be changed with  MPI_Errhandler_set  ;  the
42       predefined  error  handler MPI_ERRORS_RETURN may be used to cause error
43       values to be returned (in C and Fortran; this  error  handler  is  less
44       useful  in  with  the  C++  MPI bindings.  The predefined error handler
45       MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the  error  value
46       needs  to  be recovered).  Note that MPI does not guarantee that an MPI
47       program can continue past an error.
48
49       All MPI routines (except MPI_Wtime and  MPI_Wtick  )  return  an  error
50       value;  C routines as the value of the function and Fortran routines in
51       the last argument.  The C++ bindings for MPI do not return  error  val‐
52       ues;  instead,  error values are communicated by throwing exceptions of
53       type MPI::Exception (but not by default).  Exceptions are  only  thrown
54       if the error value is not MPI::SUCCESS .
55
56
57       Note  that  if  the MPI::ERRORS_RETURN handler is set in C++, while MPI
58       functions will return upon an error, there will be no  way  to  recover
59       what the actual error value was.
60       MPI_SUCCESS
61              - No error; MPI routine completed successfully.
62       MPI_ERR_OTHER
63              -  Other  error;  use  MPI_Error_string  to get more information
64              about this error code.
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
70

MORE INFORMATION

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
82       http://www.mpi-forum.org/
83

LOCATION

85       wcreatekey.c
86
87
88
89LAM/MPI 7.1.2                      2/23/2006          MPI_Win_create_keyval(3)