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

NAME

6       MPI_Info_get_nthkey  -   Get  a key indexed by integer from an MPI_Info
7       object
8

SYNOPSIS

10       #include <mpi.h>
11       int MPI_Info_get_nthkey(MPI_Info info, int n, char *key)
12       int MPI_Info_get_nthkey(MPI_Info info, int n, char *key)
13
14

INPUT PARAMETERS

16       info   - info object (handle)
17       n      - index of key to retrieve (integer)
18
19

OUTPUT PARAMETER

21       key    - character string of at least MPI_MAX_INFO_KEY characters
22
23

NOTES FOR FORTRAN

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

ERRORS

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

MORE INFORMATION

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

LOCATION

74       infogetnth.c
75
76
77
78LAM/MPI 7.1.2                      2/23/2006            MPI_Info_get_nthkey(3)