source: proiecte/hpl/openmpi_compiled/share/man/man3/MPI_Attr_put.3 @ 97

Last change on this file since 97 was 97, checked in by (none), 14 years ago

Adding compiled files

File size: 2.9 KB
Line 
1.\"Copyright 2006-2008 Sun Microsystems, Inc.
2.\" Copyright (c) 1996 Thinking Machines Corporation
3.TH MPI_Attr_put 3 "Dec 08, 2009" "1.4" "Open MPI"
4.SH NAME
5\fBMPI_Attr_put\fP \- Stores attribute value associated with a key -- use of this routine is deprecated.
6
7.SH SYNTAX
8.ft R
9.SH C Syntax
10.nf
11#include <mpi.h>
12int MPI_Attr_put(MPI_Comm \fIcomm\fP, int\fI keyval\fP, void\fI *attribute_val\fP)
13
14.SH Fortran Syntax
15.nf
16INCLUDE 'mpif.h'
17MPI_ATTR_PUT(\fICOMM\fP,\fI KEYVAL\fP, \fIATTRIBUTE_VAL\fP,\fI IERROR\fP)
18        INTEGER \fICOMM\fP,\fI KEYVAL\fP,\fI ATTRIBUTE_VAL\fP,\fI IERROR
19
20
21.SH INPUT PARAMETERS
22.ft R
23.TP 1i
24comm
25Communicator to which attribute will be attached (handle).
26.TP 1i
27keyval
28Key value, as returned by MPI_KEYVAL_CREATE (integer).
29.TP 1i
30attribute_val
31Attribute value.
32
33.SH OUTPUT PARAMETER
34.ft R
35.TP 1i
36IERROR
37Fortran only: Error status (integer).
38
39.SH DESCRIPTION
40.ft R
41Note that use of this routine is \fIdeprecated\fP as of MPI-2. Please use MPI_Comm_set_attr instead.
42.sp
43This deprecated routine is not available in C++.
44.sp
45MPI_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.
46
47.SH NOTES
48.ft R
49Values of the permanent attributes MPI_TAG_UB, MPI_HOST,
50MPI_IO, and MPI_WTIME_IS_GLOBAL may not be changed.
51.sp
52The 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).
53.sp
54If an attribute is already present, the delete function (specified when the corresponding keyval was created) will be called.
55
56.SH ERRORS
57Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will be used to throw an MPI:Exception object.
58.sp
59Before the error value is returned, the current MPI error handler is
60called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler
61may 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. 
62
63.SH SEE ALSO
64.ft R
65.sp
66MPI_Comm_set_attr
67.br
Note: See TracBrowser for help on using the repository browser.