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

NAME

6       MPI_Info_set -  Set a (key, value) pair in an MPI_Info object
7

SYNOPSIS

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

INPUT PARAMETERS

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

INPUT/OUTPUT PARAMETER

18       info   - info object (handle)
19
20

NOTES FOR FORTRAN

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

ERRORS

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

MORE INFORMATION

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

LOCATION

84       infoset.c
85
86
87
88LAM/MPI 7.1.2                      2/23/2006                   MPI_Info_set(3)
Impressum