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

NAME

6       MPI_Info_delete -  Delete a (key, value) pair from an MPI_Info object
7

SYNOPSIS

9       #include <mpi.h>
10       int MPI_Info_delete(MPI_Info info, char *key)
11

INPUT PARAMETER

13       key    - null-terminated character string of the index key
14
15

INPUT/OUTPUT PARAMETER

17       info   - info object (handle)
18
19

NOTES FOR FORTRAN

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

ERRORS

32       If an error occurs in an MPI function, the current MPI error handler is
33       called  to  handle  it.   By default, this error handler aborts the MPI
34       job.  The error handler may be changed with  MPI_Errhandler_set  ;  the
35       predefined  error  handler MPI_ERRORS_RETURN may be used to cause error
36       values to be returned (in C and Fortran; this  error  handler  is  less
37       useful  in  with  the  C++  MPI bindings.  The predefined error handler
38       MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the  error  value
39       needs  to  be recovered).  Note that MPI does not guarantee that an MPI
40       program can continue past an error.
41
42       All MPI routines (except MPI_Wtime and  MPI_Wtick  )  return  an  error
43       value;  C routines as the value of the function and Fortran routines in
44       the last argument.  The C++ bindings for MPI do not return  error  val‐
45       ues;  instead,  error values are communicated by throwing exceptions of
46       type MPI::Exception (but not by default).  Exceptions are  only  thrown
47       if the error value is not MPI::SUCCESS .
48
49
50       Note  that  if  the MPI::ERRORS_RETURN handler is set in C++, while MPI
51       functions will return upon an error, there will be no  way  to  recover
52       what the actual error value was.
53       MPI_SUCCESS
54              - No error; MPI routine completed successfully.
55       MPI_ERR_ARG
56              - Invalid argument.  Some argument is invalid and is not identi‐
57              fied by a specific  error  class.   This  is  typically  a  NULL
58              pointer or other such error.
59       MPI_INFO_KEY
60              -  This  error class is associated with an error code that indi‐
61              cates that a null key, empty key, or key that  was  longer  than
62              MPI_MAX_INFO_KEY  characters was passed as an argument to an MPI
63              function where it was not allowed.
64       MPI_INFO_NOKEY
65              - This error class is associated with an error code  that  indi‐
66              cates  that  a  key that was looked up on an MPI_Info object and
67              was not found.
68       MPI_ERR_INTERN
69              - An internal error has been detected.  This is  fatal.   Please
70              send  a  bug report to the LAM mailing list (see http://www.lam-
71              mpi.org/contact.php ).
72
73

MORE INFORMATION

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

LOCATION

83       infodel.c
84
85
86
87LAM/MPI 7.1.2                      2/23/2006                MPI_Info_delete(3)
Impressum