Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
MPI_Attr_put(3) 		       MPI			 MPI_Attr_put(3)

NAME
     MPI_Attr_put -  Stores attribute value associated with a key

SYNOPSIS
     int MPI_Attr_put(MPI_Comm comm, int keyval, void *attribute_val)

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 (None)

DEPRECATED FUNCTION
     The  current  MPI	standard defines this routine as deprecated. The routine
     may continue to be used, but new code should use the  replacement	routine.
     The replacement for this routine is MPI_Comm_set_attr .

THREAD AND INTERRUPT SAFETY
     This  routine  is	thread-safe.  This means that this routine may be safely
     used by multiple threads without the  need  for  any  user-provided  thread
     locks.  However, the routine is not interrupt safe.  Typically, this is due
     to  the use of memory allocation routines such as malloc or other non-MPICH
     runtime routines that are themselves not interrupt-safe.

NOTES FOR FORTRAN
     All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK )	have  an
     additional argument ierr at the end of the argument list.	ierr is an inte-
     ger  and  has the same meaning as the return value of the routine in C.  In
     Fortran, MPI routines are subroutines, and are invoked with the call state-
     ment.

     All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are  of  type  INTEGER  in
     Fortran.

ERRORS
     All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error value; C
     routines  as the value of the function and Fortran routines in the last ar-
     gument.  Before the value is returned, the current  MPI  error  handler  is
     called.  By default, this error handler aborts the MPI job.  The error han-
     dler  may	be  changed  with  MPI_Comm_set_errhandler  (for communicators),
     MPI_File_set_errhandler (for files), and  MPI_Win_set_errhandler  (for  RMA
     windows).	 The MPI-1 routine MPI_Errhandler_set may be used but its use is
     deprecated.  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;  however,  MPI  implementations
     will attempt to continue whenever possible.

     MPI_SUCCESS
	    - No error; MPI routine completed successfully.
     MPI_ERR_COMM
	    -  Invalid communicator.  A common error is to use a null communica-
	    tor in a call (not even allowed in MPI_Comm_rank ).
     MPI_ERR_KEYVAL
	    - Invalid keyval
     MPI_ERR_OTHER
	    - Other error; use MPI_Error_string to get	more  information  about
	    this error code.

SEE ALSO
     MPI_Attr_get, MPI_Keyval_create, MPI_Attr_delete, MPI_Comm_set_attr

				    4/10/2026			 MPI_Attr_put(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=MPI_Attr_put&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help