Open MPI logo

MPI_Attr_put(3) man page (version 1.3.4)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing



NAME

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

SYNTAX


C Syntax

       #include <mpi.h>
       int MPI_Attr_put(MPI_Comm comm, int keyval, void *attribute_val)

Fortran Syntax

       INCLUDE 'mpif.h'
       MPI_ATTR_PUT(COMM, KEYVAL, ATTRIBUTE_VAL, IERROR)
            INTEGER   COMM, KEYVAL, ATTRIBUTE_VAL, IERROR

INPUT PARAMETERS

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

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

       attribute_val
                 Attribute value.

OUTPUT PARAMETER

       IERROR    Fortran only: Error status (integer).

DESCRIPTION

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

       This deprecated routine is not available in C++.

       MPI_Attr_put  stores  the  stipulated attribute value attribute_val for
       subsequent retrieval by MPI_Attr_get. If the value is already  present,
       then  the  outcome  is as if MPI_Attr_delete was first called to delete
       the previous value (and the callback function delete_fn was  executed),
       and  a  new value was next stored. The call is erroneous if there is no
       key with value keyval; in particular MPI_KEYVAL_INVALID is an erroneous
       key  value.  The  call  will fail if the delete_fn function returned an
       error code other than MPI_SUCCESS.

NOTES

       Values of the permanent attributes MPI_TAG_UB,  MPI_HOST,  MPI_IO,  and
       MPI_WTIME_IS_GLOBAL 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).

       MPI::ERRORS_THROW_EXCEPTIONS, 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
       MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN
       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

       MPI_Comm_set_attr

1.3.4                            Nov 11, 2009                  MPI_Attr_put(3)

« Return to documentation listing