MPICommsetattr(3OpenMPI) MPICommsetattr(3OpenMPI)

NAME
       MMPPIICCoommmmsseettaattttrr - Stores attribute value associated with a key.


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


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


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


IINNPPUUTT//OOUUTTPPUUTT PPAARRAAMMEETTEERR
       comm      Communicator  from which attribute will be attached (handle).


IINNPPUUTT PPAARRAAMMEETTEERRSS
       commkeyval
                 Key value (integer).

       attributeval
                 Attribute value.


OOUUTTPPUUTT PPAARRAAMMEETTEERR
       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       MPICommsetattr stores the stipulated attribute  value  attributeval
       for  subsequent retrieval by MPICommgetattr. If the value is already
       present, then the outcome  is  as  if  MPICommdeleteattr  was  first
       called  to  delete  the  previous  value  (and  the  callback  function
       deletefn was executed), and a new value was next stored. The  call  is
       erroneous  if  there  is  no  key with value commkeyval; in particular
       MPIKEYVALINVALID is an erroneous key value. The call will fail if the
       deletefn function returned an error code other than MPISUCCESS.

       This  function  replaces  MPIAttrput, 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.


NNOOTTEESS
       Values of the permanent attributes MPITAGUB,  MPIHOST,  MPIIO,  and
       MPIWTIMEISGLOBAL may not be changed.

       The  type  of  the  attribute  value depends on whether C or Fortran is
       being used. In C, an attribute value is a pointer (void *); in Fortran,
       it  is  a  single, address-size integer system for which a pointer does
       not fit in an integer.

       If an attribute is already present, the delete function (specified when
       the corresponding keyval was created) will be called.


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     MPICommsetattr(3OpenMPI)