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

NAME

6       MPI_Type_free_keyval -  Free datatype attribuet key
7

SYNOPSIS

9       #include <mpi.h>
10       int
11       MPI_Type_free_keyval(int *key)
12

INPUT PARAMETER

14       key    - Key value (integer)
15
16

NOTES FOR FORTRAN

18       All  MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
19       an additional argument ierr at the end of the argument list.   ierr  is
20       an  integer and has the same meaning as the return value of the routine
21       in C.  In Fortran, MPI routines are subroutines, and are  invoked  with
22       the call statement.
23
24       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
25       Fortran.
26
27

ERRORS

29       If an error occurs in an MPI function, the current MPI error handler is
30       called  to  handle  it.   By default, this error handler aborts the MPI
31       job.  The error handler may be changed with  MPI_Errhandler_set  ;  the
32       predefined  error  handler MPI_ERRORS_RETURN may be used to cause error
33       values to be returned (in C and Fortran; this  error  handler  is  less
34       useful  in  with  the  C++  MPI bindings.  The predefined error handler
35       MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the  error  value
36       needs  to  be recovered).  Note that MPI does not guarantee that an MPI
37       program can continue past an error.
38
39       All MPI routines (except MPI_Wtime and  MPI_Wtick  )  return  an  error
40       value;  C routines as the value of the function and Fortran routines in
41       the last argument.  The C++ bindings for MPI do not return  error  val‐
42       ues;  instead,  error values are communicated by throwing exceptions of
43       type MPI::Exception (but not by default).  Exceptions are  only  thrown
44       if the error value is not MPI::SUCCESS .
45
46
47       Note  that  if  the MPI::ERRORS_RETURN handler is set in C++, while MPI
48       functions will return upon an error, there will be no  way  to  recover
49       what the actual error value was.
50       MPI_SUCCESS
51              - No error; MPI routine completed successfully.
52       MPI_ERR_TYPE
53              - Invalid datatype argument.  May be an uncommitted MPI_Datatype
54              (see MPI_Type_commit ).
55       MPI_ERR_OTHER
56              - Other error; the error code associated with this  error  indi‐
57              cates an attempt to use an invalue keyval.
58       MPI_ERR_ARG
59              - Invalid argument.  Some argument is invalid and is not identi‐
60              fied by a specific  error  class.   This  is  typically  a  NULL
61              pointer or other such error.
62
63

SEE ALSO

65       MPI_Type_create_keyval(3),  MPI_Type_get_attr(3), MPI_Type_set_attr(3),
66       MPI_Type_delete_attr(3)
67
68

MORE INFORMATION

70       For more information, please see the official MPI Forum web site, which
71       contains  the  text of both the MPI-1 and MPI-2 standards.  These docu‐
72       ments contain detailed information about each  MPI  function  (most  of
73       which is not duplicated in these man pages).
74
75       http://www.mpi-forum.org/
76

LOCATION

78       tfreekey.c
79
80
81
82LAM/MPI 7.1.2                      2/23/2006           MPI_Type_free_keyval(3)