File: PMIx_Finalize.3

package info (click to toggle)
openmpi 5.0.8-4
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 201,684 kB
  • sloc: ansic: 613,078; makefile: 42,353; sh: 11,194; javascript: 9,244; f90: 7,052; java: 6,404; perl: 5,179; python: 1,859; lex: 740; fortran: 61; cpp: 20; tcl: 12
file content (73 lines) | stat: -rw-r--r-- 1,505 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
.\" Man page generated from reStructuredText.
.
.TH "PMIX_FINALIZE" "3" "May 30, 2025" "" "OpenPMIx"
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.sp
PMIx_Finalize \- Finalize the PMIx Client
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#include <pmix.h>

pmix_status_t PMIx_Finalize(void);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
Finalize the PMIx client, closing the connection with the local PMIx
server.
.SH RETURN VALUE
.sp
Returns \fBPMIX_SUCCESS\fP on success. On error, a negative value
corresponding to a PMIx \fBerrno\fP is returned.
.SH ERRORS
.sp
PMIx \fBerrno\fP values are defined in \fBpmix_common.h\fP\&.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%PMIx_Abort(3)\fP,
PMIx_Commit(3),
\fI\%PMIx_Init(3)\fP,
PMIx_Initialized(3),
PMIx_Put(3),
pmiAddInstance(3),
pmiAddMetric(3)
.UNINDENT
.UNINDENT
.SH COPYRIGHT
2014-2025, OpenPMIx Community
.\" Generated by docutils manpage writer.
.