MPIAttrget(3OpenMPI) MPIAttrget(3OpenMPI)

NAME
       MMPPIIAAttttrrggeett  - Retrieves attribute value by key - use of this routine
       is deprecated.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIAttrget(MPIComm comm, int keyval,void *attributeval,
            int *flag )


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPIATTRGET(COMM, KEYVAL, ATTRIBUTEVAL, FLAG, IERROR)
            INTEGER   COMM, KEYVAL, ATTRIBUTEVAL, IERROR
            LOGICAL   FLAG



IINNPPUUTT PPAARRAAMMEETTEERRSS
       comm      Communicator to which attribute is attached (handle).

       keyval     Key value (integer).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       attributeval
                 Attribute value, unless flag = false.

       flag      True if  an  attribute  value  was  extracted;  false  if  no
                 attribute is associated with the key.

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       Note  that  use  of  this routine is deprecated as of MPI-2. Please use
       MPICommgetattr instead.

       This deprecated routine is not available in C++.

       Retrieves attribute value by key. The call is erroneous if there is  no
       key  with  value  keyval. On the other hand, the call is correct if the
       key value exists, but no attribute is attached on comm for that key; in
       such  case,  the  call  returns  flag  =  false. In particular MPIKEY-
       VALINVALID is an erroneous key value.


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
       MPICommgetattr



Open MPI 1.2                    September 2006          MPIAttrget(3OpenMPI)