MPIInfogetvaluelen(3OpenMPI) MPIInfogetvaluelen(3OpenMPI)

NAME
       MMPPIIIInnffooggeettvvaalluueelleenn  -  Retrieves the length of the key value associ-
       ated with an info object.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIInfogetvaluelen(MPIInfo info, char *key,
            int *valuelen, int *flag)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPIINFOGETVALUELEN(INFO, KEY, VALUELEN, FLAG, IERROR)
            INTEGER        INFO, VALUELEN, IERROR
            LOGICAL        FLAG
            CHARACTER*(*)  KEY


CC++++ SSyynnttaaxx
       #include 
       bool MPI::Info::Getvaluelen(const char* key, int& valuelen)
            const


IINNPPUUTT PPAARRAAMMEETTEERRSS
       info      Info object (handle).

       key       Key (string).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       valuelen  Length of value arg (integer).

       flag      Returns true if key defined, false if not (boolean).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       MPIInfogetvaluelen retrieves the length of the value associated with
       key. If key is defined, valuelen is set to the length of its associated
       value and flag is set to true. If key is not defined, valuelen  is  not
       touched  and flag is set to false. The length returned in C or C++ does
       not include the end-of-string character.

       If key is larger than MPIMAXINFOKEY, the call is erroneous.


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
       MPIInfogetnthkey




Open MPI 1.2                    September 2006 MPIInfogetvaluelen(3OpenMPI)