MPICommgetattr(3OpenMPI) MPICommgetattr(3OpenMPI)

NAME
       MMPPIICCoommmmggeettaattttrr - Retrieves attribute value by key.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPICommgetattr(MPIComm comm, int commkeyval,
            void *attributeval, int *flag)


FFoorrttrraann SSyynnttaaxx ((sseeee FFOORRTTRRAANN 7777 NNOOTTEESS))
       INCLUDE 'mpif.h'
       MPICOMMGETATTR(COMM, COMMKEYVAL, ATTRIBUTEVAL, IERROR)
            INTEGER   COMM, COMMKEYVAL, IERROR
            INTEGER(KIND=MPIADDRESSKIND) ATTRIBUTEVAL
            LOGICAL FLAG


CC++++ SSyynnttaaxx
       #include 
       bool MPI::Comm::Getattr(int commkeyval, void* attributeval)
            const


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

       commkeyval
                 Key value (integer).


OOUUTTPPUUTT PPAARRAAMMEETTEERR
       attributeval
                 Attribute value, unless flag = false.

       flag      False if no attribute is associated with the key (logical).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       MPICommgetattr  retrieves  an  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 that case, the call returns flag =  false.  In
       particular, MPIKEYVALINVALID is an erroneous key value.

       This  function  replaces  MPIAttrget, the use of which is deprecated.
       The C binding  is  identical.  The  Fortran  binding  differs  in  that
       attributeval is an address-sized integer.


FFOORRTTRRAANN 7777 NNOOTTEESS
       The   MPI   standard   prescribes   portable  Fortran  syntax  for  the
       ATTRIBUTEVAL argument only for Fortran 90. Sun FORTRAN  77  users  may
       use the non-portable syntax

            INTEGER*MPIADDRESSKIND ATTRIBUTEVAL

       where  MPIADDRESSKIND  is  a constant defined in mpif.h and gives the
       length of the declared integer in bytes.


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.




Open MPI 1.2                    September 2006     MPICommgetattr(3OpenMPI)