[97] | 1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
| 2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
| 3 | .TH MPI_Attr_get 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
| 4 | .SH NAME |
---|
| 5 | \fBMPI_Attr_get\fP \- Retrieves attribute value by key -- use of this routine is deprecated. |
---|
| 6 | |
---|
| 7 | .SH SYNTAX |
---|
| 8 | .ft R |
---|
| 9 | .SH C Syntax |
---|
| 10 | .nf |
---|
| 11 | #include <mpi.h> |
---|
| 12 | int MPI_Attr_get(MPI_Comm \fIcomm\fP, int\fI keyval\fP,void\fI *attribute_val\fP, |
---|
| 13 | int\fI *flag \fP) |
---|
| 14 | |
---|
| 15 | .SH Fortran Syntax |
---|
| 16 | .nf |
---|
| 17 | INCLUDE 'mpif.h' |
---|
| 18 | MPI_ATTR_GET(\fICOMM\fP,\fI KEYVAL\fP, \fIATTRIBUTE_VAL\fP,\fI FLAG\fP,\fI IERROR\fP) |
---|
| 19 | INTEGER \fICOMM\fP,\fI KEYVAL\fP, \fIATTRIBUTE_VAL\fP,\fI IERROR\fP |
---|
| 20 | LOGICAL \fIFLAG\fP |
---|
| 21 | |
---|
| 22 | |
---|
| 23 | .SH INPUT PARAMETERS |
---|
| 24 | .ft R |
---|
| 25 | .TP 1i |
---|
| 26 | comm |
---|
| 27 | Communicator to which attribute is attached (handle). |
---|
| 28 | .TP 1i |
---|
| 29 | keyval |
---|
| 30 | Key value (integer). |
---|
| 31 | |
---|
| 32 | .SH OUTPUT PARAMETERS |
---|
| 33 | .ft R |
---|
| 34 | .TP 1i |
---|
| 35 | attribute_val |
---|
| 36 | Attribute value, unless flag = false. |
---|
| 37 | .TP 1i |
---|
| 38 | flag |
---|
| 39 | True if an attribute value was extracted; false if no attribute is associated with the key. |
---|
| 40 | .ft R |
---|
| 41 | .TP 1i |
---|
| 42 | IERROR |
---|
| 43 | Fortran only: Error status (integer). |
---|
| 44 | |
---|
| 45 | .SH DESCRIPTION |
---|
| 46 | .ft R |
---|
| 47 | Note that use of this routine is \fIdeprecated\fP as of MPI-2. Please use MPI_Comm_get_attr instead. |
---|
| 48 | .sp |
---|
| 49 | This deprecated routine is not available in C++. |
---|
| 50 | .sp |
---|
| 51 | Retrieves attribute value by key. The call is erroneous if there is no key |
---|
| 52 | with value keyval. On the other hand, the call is correct if the key value exists, but no attribute is attached on comm for that key; in such case, the call returns flag = false. In particular MPI_KEYVAL_INVALID is an erroneous key value. |
---|
| 53 | |
---|
| 54 | .SH ERRORS |
---|
| 55 | Almost 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. |
---|
| 56 | .sp |
---|
| 57 | Before the error value is returned, the current MPI error handler is |
---|
| 58 | called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler |
---|
| 59 | 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. |
---|
| 60 | |
---|
| 61 | |
---|
| 62 | .SH SEE ALSO |
---|
| 63 | |
---|
| 64 | MPI_Comm_get_attr |
---|
| 65 | .br |
---|