MPIAttrput(3OpenMPI) MPIAttrput(3OpenMPI)

NAME
       MMPPIIAAttttrrppuutt  -  Stores attribute value associated with a key - use of
       this routine is deprecated.


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


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPIATTRPUT(COMM, KEYVAL, ATTRIBUTEVAL, IERROR)
            INTEGER   COMM, KEYVAL, ATTRIBUTEVAL, IERROR



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

       keyval    Key value, as returned by MPIKEYVALCREATE (integer).

       attributeval
                 Attribute value.


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


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

       This deprecated routine is not available in C++.

       MPIAttrput  stores  the  stipulated attribute value attributeval for
       subsequent retrieval by MPIAttrget. If the value is already  present,
       then  the  outcome  is as if MPIAttrdelete 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 keyval; in particular MPIKEYVALINVALID is an erroneous
       key  value.  The  call  will fail if the deletefn function returned an
       error code other than MPISUCCESS.


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 integer (not a pointer, since Fortran has no pointers
       and there are systems for which a pointer does not fit in  an  integer,
       e.g.,  any   32-bit address system that uses 64 bits for Fortran DOUBLE
       PRECISION).

       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.


SEE ALSO
       MPICommsetattr



Open MPI 1.2                    September 2006          MPIAttrput(3OpenMPI)