Line | |
---|
1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Info_delete 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Info_delete\fP \- Deletes a key/value pair from \fIinfo\fP. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Info_delete(MPI_Info \fIinfo\fP, char \fI*key\fP) |
---|
13 | |
---|
14 | .SH Fortran Syntax |
---|
15 | .nf |
---|
16 | INCLUDE 'mpif.h' |
---|
17 | MPI_INFO_DELETE(\fIINFO, KEY, IERROR\fP) |
---|
18 | INTEGER \fIINFO, IERROR\fP |
---|
19 | CHARACTER*(*) \fIKEY\fP |
---|
20 | |
---|
21 | .SH C++ Syntax |
---|
22 | .nf |
---|
23 | #include <mpi.h> |
---|
24 | void MPI::Info::Delete(const char* \fIkey\fP) |
---|
25 | |
---|
26 | .SH INPUT/OUTPUT PARAMETER |
---|
27 | .ft R |
---|
28 | .TP 1i |
---|
29 | info |
---|
30 | Info object (handle). |
---|
31 | |
---|
32 | .SH INPUT PARAMETER |
---|
33 | .ft R |
---|
34 | .TP 1i |
---|
35 | key |
---|
36 | Key (string). |
---|
37 | |
---|
38 | .SH OUTPUT PARAMETER |
---|
39 | .ft R |
---|
40 | .TP 1i |
---|
41 | IERROR |
---|
42 | Fortran only: Error status (integer). |
---|
43 | |
---|
44 | .SH DESCRIPTION |
---|
45 | .ft R |
---|
46 | MPI_Info_delete deletes a (key,value) pair from \fIinfo\fP. If \fIkey\fP is not defined in \fIinfo\fP, the call raises an error of class MPI_ERR_INFO_NOKEY. |
---|
47 | |
---|
48 | .SH ERRORS |
---|
49 | 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. |
---|
50 | .sp |
---|
51 | Before the error value is returned, the current MPI error handler is |
---|
52 | 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. |
---|
53 | |
---|
54 | .SH SEE ALSO |
---|
55 | .ft r |
---|
56 | MPI_Info_create |
---|
57 | .br |
---|
58 | MPI_Info_dup |
---|
59 | .br |
---|
60 | MPI_Info_free |
---|
61 | .br |
---|
62 | MPI_Info_get |
---|
63 | .br |
---|
64 | MPI_Info_set |
---|
65 | .br |
---|
66 | |
---|
Note: See
TracBrowser
for help on using the repository browser.