1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\"Copyright (c) 1996 Thinking Machines |
---|
3 | .TH MPI_Comm_delete_attr 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Comm_delete_attr\fP \- Deletes attribute value associated with a key. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Comm_delete_attr(MPI_Comm \fIcomm\fP, int \fIcomm_keyval\fP) |
---|
13 | |
---|
14 | .SH Fortran Syntax |
---|
15 | .nf |
---|
16 | INCLUDE 'mpif.h' |
---|
17 | MPI_Comm_delete_attr(\fICOMM, COMM_KEYVAL, IERROR\fP) |
---|
18 | INTEGER \fICOMM, COMM_KEYVAL, IERROR \fP |
---|
19 | |
---|
20 | .SH C++ Syntax |
---|
21 | .nf |
---|
22 | #include <mpi.h> |
---|
23 | void MPI::Comm::Delete_attr(int \fIcomm_keyval\fP) |
---|
24 | |
---|
25 | .SH INPUT/OUTPUT PARAMETER |
---|
26 | .ft R |
---|
27 | .TP 1i |
---|
28 | comm |
---|
29 | Communicator from which the attribute is deleted (handle). |
---|
30 | |
---|
31 | .SH INPUT PARAMETER |
---|
32 | .ft R |
---|
33 | .TP 1i |
---|
34 | comm_keyval |
---|
35 | Key value (integer). |
---|
36 | |
---|
37 | .SH OUTPUT PARAMETER |
---|
38 | .ft R |
---|
39 | .TP 1i |
---|
40 | IERROR |
---|
41 | Fortran only: Error status (integer). |
---|
42 | |
---|
43 | .SH DESCRIPTION |
---|
44 | .ft R |
---|
45 | MPI_Comm_delete_attr deletes an attribute from cache by key. This function invokes the attribute delete function delete_fn specified when the \fIcomm_keyval\fP was created. The call will fail if the delete_fn function returns an error code other than MPI_SUCCESS. |
---|
46 | |
---|
47 | Whenever a communicator is replicated using the function MPI_Comm_dup, all callback copy functions for attributes that are currently set are invoked (in arbitrary order). Whenever a communicator is deleted using the function MPI_Comm_free, all callback delete functions for attributes that are currently set are invoked. |
---|
48 | .sp |
---|
49 | This function is the same as MPI_Attr_delete but is needed to match the communicator-specific functions introduced in the MPI-2 standard. The use of MPI_Attr_delete is deprecated. |
---|
50 | |
---|
51 | |
---|
52 | .SH ERRORS |
---|
53 | 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. |
---|
54 | .sp |
---|
55 | Before the error value is returned, the current MPI error handler is |
---|
56 | 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. |
---|
57 | |
---|