MPIInfogetnthkey(3OpenMPI) MPIInfogetnthkey(3OpenMPI)

NAME
       MMPPIIIInnffooggeettnntthhkkeeyy - Returns the nth defined key in info.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIInfogetnthkey(MPIInfo info, int n, char *key)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPIINFOGETNTHKEY(INFO, N, KEY, IERROR)
            INTEGER        INFO, N, IERROR
            CHARACTER*(*)  KEY


CC++++ SSyynnttaaxx
       #include 
       void MPI::Info::Getnthkey(int n, char* key) const


IINNPPUUTT PPAARRAAMMEETTEERRSS
       info      Info object (handle).

       n         Key number (integer).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       key       Key (string).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       MPIInfogetnthkey  returns the nth defined key in info. Keys are num-
       bered 0...N - 1 where N is the value  returned  by  MPIInfogetnkeys.
       All  keys  between 0 and N - 1 are guaranteed to be defined. The number
       of a given key does not change as long as info  is  not  modified  with
       MPIInfoset or MPIInfodelete.


EERRRROORRSS
       Almost  all MPI routines return an error value; C routines as the value
       of the function and Fortran routines in the last  argument.  C++  func-
       tions  do  not  return  errors.  If the default error handler is set to
       MPI::ERRORSTHROWEXCEPTIONS, then on error the C++ exception mechanism
       will be used to throw an MPI:Exception object.

       Before  the  error  value is returned, the current MPI error handler is
       called. By default, this error handler aborts the MPI job,  except  for
       I/O   function   errors.   The   error  handler  may  be  changed  with
       MPICommseterrhandler; the predefined error handler MPIERRORSRETURN
       may  be  used  to cause error values to be returned. Note that MPI does
       not guarantee that an MPI program can continue past an error.


SEE ALSO
       MPIInfoget
       MPIInfogetnkeys
       MPIInfogetvalueln




Open MPI 1.2                    September 2006   MPIInfogetnthkey(3OpenMPI)