Skip to content

Commit 8b31d0f

Browse files
committed
Convert MPI_T_cvar_write from Nroff to Markdown
Signed-off-by: Tariq Fuller <[email protected]>
1 parent d330551 commit 8b31d0f

File tree

2 files changed

+49
-59
lines changed

2 files changed

+49
-59
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Name
2+
MPI\_T\_cvar\_write - Write the value of a bound control variable
3+
4+
# Syntax
5+
## C Syntax
6+
c
7+
#include <mpi.h>
8+
int MPI_T_cvar_write(MPI_T_cvar_handle handle, const void *buf)
9+
10+
11+
# Input Parameters
12+
`handle` : Handle of the control variable to be written.
13+
`buf` : Initial address of storage location for variable value.
14+
15+
# Description
16+
17+
MPI\_T\_cvar\_write sets the value the control variable identified by
18+
the handle specified in *handle* from the buffer provided in *buf*. The
19+
caller must ensure that the buffer specified in *buf* is large enough to
20+
hold the entire value of the control variable. If the variable has
21+
global scope, any write call must be issued on all connected MPI
22+
processes. For more information see MPI-3 � 14.3.6.
23+
24+
25+
# Errors
26+
27+
MPI\_T\_cvar\_write() will fail if:
28+
29+
`\[MPI\_T\_ERR\_NOT\_INITIALIZED\]` : The MPI Tools interface not initialized
30+
31+
: The MPI Tools interface not initialized
32+
33+
`\[MPI\_T\_ERR\_INVALID\_HANDLE\]` : The handle is invalid
34+
35+
: The handle is invalid
36+
37+
`\[MPI\_T\_ERR\_CVAR\_SET\_NOT\_NOW\]` : Variable cannot be set at this moment
38+
39+
: Variable cannot be set at this moment
40+
41+
`\[MPI\_T\_ERR\_CVAR\_SET\_NEVER\]` : Variable cannot be set until end of execution
42+
43+
: Variable cannot be set until end of execution
44+
45+
46+
# See Also
47+
48+
MPI_T_cvar_handle_alloc
49+
MPI_T_cvar_get_info

ompi/mpi/man/man3/MPI_T_cvar_write.3in

Lines changed: 0 additions & 59 deletions
This file was deleted.

0 commit comments

Comments
 (0)