Line | |
---|
1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Info_get_nthkey 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Info_get_nthkey\fP \- Returns the \fIn\fPth defined key in \fIinfo\fP. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Info_get_nthkey(MPI_Info \fIinfo\fP, int \fIn\fP, char \fI*key\fP) |
---|
13 | |
---|
14 | .SH Fortran Syntax |
---|
15 | .nf |
---|
16 | INCLUDE 'mpif.h' |
---|
17 | MPI_INFO_GET_NTHKEY(\fIINFO, N, KEY, IERROR\fP) |
---|
18 | INTEGER \fIINFO, N, IERROR\fP |
---|
19 | CHARACTER*(*) \fIKEY\fP |
---|
20 | |
---|
21 | .SH C++ Syntax |
---|
22 | .nf |
---|
23 | #include <mpi.h> |
---|
24 | void MPI::Info::Get_nthkey(int \fIn\fP, char* \fIkey\fP) const |
---|
25 | |
---|
26 | .SH INPUT PARAMETERS |
---|
27 | .ft R |
---|
28 | .TP 1i |
---|
29 | info |
---|
30 | Info object (handle). |
---|
31 | .ft R |
---|
32 | .TP 1i |
---|
33 | n |
---|
34 | Key number (integer). |
---|
35 | |
---|
36 | .SH OUTPUT PARAMETERS |
---|
37 | .ft R |
---|
38 | .TP 1i |
---|
39 | key |
---|
40 | Key (string). |
---|
41 | .ft R |
---|
42 | .TP 1i |
---|
43 | IERROR |
---|
44 | Fortran only: Error status (integer). |
---|
45 | |
---|
46 | .SH DESCRIPTION |
---|
47 | .ft R |
---|
48 | MPI_Info_get_nthkey returns the \fIn\fPth defined key in \fIinfo\fP. Keys are numbered 0\...\fIN\fP - 1 where \fIN\fP is the value returned by MPI_Info_get_nkeys. All keys between 0 and \fIN\fP - 1 are guaranteed to be defined. The number of a given key does not change as long as \fIinfo\fP is not modified with MPI_Info_set or MPI_Info_delete. |
---|
49 | |
---|
50 | .SH ERRORS |
---|
51 | 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. |
---|
52 | .sp |
---|
53 | Before the error value is returned, the current MPI error handler is |
---|
54 | 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. |
---|
55 | |
---|
56 | .SH SEE ALSO |
---|
57 | .ft r |
---|
58 | MPI_Info_get |
---|
59 | .br |
---|
60 | MPI_Info_get_nkeys |
---|
61 | .br |
---|
62 | MPI_Info_get_valueln |
---|
63 | .br |
---|
64 | |
---|
Note: See
TracBrowser
for help on using the repository browser.