MPI_Type_create_keyval(3)

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

NAME

6       MPI_Type_create_keyval -  Create a datatype attribute key
7

SYNOPSIS

9       #include <mpi.h>
10       int
11       MPI_Type_create_keyval(MPI_Type_copy_attr_function *cpyfunc,
12                              MPI_Type_delete_attr_function *delfunc, int *key,
13                              void *extra)
14

INPUT PARAMETERS

16       copyfunc
17              - Copy callback function for type_keyval (function)
18       delfunc
19              - Delete callback function for type_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

USAGE WITH IMPI EXTENSIONS

39       The IMPI standard only supports MPI-1 functions.  Hence, this  function
40       is currently not designed to operate within an IMPI job.
41
42

ERRORS

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
54       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
61
62       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       MPI_ERR_TYPE
68              - Invalid datatype argument.  May be an uncommitted MPI_Datatype
69              (see MPI_Type_commit ).
70       MPI_ERR_OTHER
71              -  Other  error; the error code associated with this error indi‐
72              cates an attempt to use an invalue keyval.
73       MPI_ERR_ARG
74              - Invalid argument.  Some argument is invalid and is not identi‐
75              fied  by  a  specific  error  class.   This  is typically a NULL
76              pointer or other such error.
77
78

MORE INFORMATION

85       For more information, please see the official MPI Forum web site, which
86       contains the text of both the MPI-1 and MPI-2 standards.   These  docu‐
87       ments  contain  detailed  information  about each MPI function (most of
88       which is not duplicated in these man pages).
89
90       http://www.mpi-forum.org/
91

LOCATION

93       tcreatekey.c
94
95
96
97LAM/MPI 7.1.2                      2/23/2006         MPI_Type_create_keyval(3)