74 lines
1.5 KiB
Groff
74 lines
1.5 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH "PMIX_FINALIZE" "3" "Feb 14, 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, The OpenPMIx Community
|
|
.\" Generated by docutils manpage writer.
|
|
.
|