1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Info_set 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Info_set\fP \- Adds a key/value pair to \fIinfo\fP. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Info_set(MPI_Info \fIinfo\fP, char \fI*key\fP, char \fI*value\fP) |
---|
13 | |
---|
14 | .SH Fortran Syntax |
---|
15 | .nf |
---|
16 | INCLUDE 'mpif.h' |
---|
17 | MPI_INFO_SET(\fIINFO, KEY, VALUE, IERROR\fP) |
---|
18 | INTEGER \fIINFO, IERROR\fP |
---|
19 | CHARACTER*(*) \fIKEY, VALUE\fP |
---|
20 | |
---|
21 | .SH C++ Syntax |
---|
22 | .nf |
---|
23 | #include <mpi.h> |
---|
24 | void MPI::Info::Set(const char* \fIkey\fP, const char* \fIvalue\fP) |
---|
25 | |
---|
26 | .SH INPUT/OUTPUT PARAMETER |
---|
27 | .ft R |
---|
28 | .TP 1i |
---|
29 | info |
---|
30 | Info object (handle). |
---|
31 | |
---|
32 | .SH INPUT PARAMETERS |
---|
33 | .ft R |
---|
34 | .TP 1i |
---|
35 | key |
---|
36 | Key (string). |
---|
37 | .ft R |
---|
38 | .TP 1i |
---|
39 | value |
---|
40 | Value (string). |
---|
41 | |
---|
42 | .SH OUTPUT PARAMETER |
---|
43 | .ft R |
---|
44 | .TP 1i |
---|
45 | IERROR |
---|
46 | Fortran only: Error status (integer). |
---|
47 | |
---|
48 | .SH DESCRIPTION |
---|
49 | .ft R |
---|
50 | MPI_Info_set adds the (key,value) pair to \fIinfo\fP and overrides the value if a value for the same key was previously set. The \fIkey\fP and \fIvalue\fP parameters are null-terminated strings in C. In Fortran, leading and trailing spaces in \fIkey\fP and \fIvalue\fP are stripped. If either \fIkey\fP or \fIvalue\fP is larger than the allowed maximums, the error MPI_ERR_INFO_KEY or MPI_ERR_INFO_VALUE is raised, respectively. |
---|
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 | |
---|
58 | .SH SEE ALSO |
---|
59 | .ft r |
---|
60 | MPI_Info_create |
---|
61 | .br |
---|
62 | MPI_Info_delete |
---|
63 | .br |
---|
64 | MPI_Info_dup |
---|
65 | .br |
---|
66 | MPI_Info_free |
---|
67 | .br |
---|
68 | MPI_Info_set |
---|
69 | .br |
---|
70 | |
---|