97 lines
2.5 KiB
Groff
97 lines
2.5 KiB
Groff
.\" Man page generated from reStructuredText.
|
||
.
|
||
.TH "PMIX_INIT" "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_Init \- Initialize the PMIx Client
|
||
.SH SYNOPSIS
|
||
.INDENT 0.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
#include <pmix.h>
|
||
|
||
pmix_status_t PMIx_Init(pmix_proc_t *proc);
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.SH ARGUMENTS
|
||
.INDENT 0.0
|
||
.IP \(bu 2
|
||
\fBproc\fP: Pointer to a \fBpmix_proc_t\fP object in which the client’s
|
||
namespace and rank are to be returned.
|
||
.UNINDENT
|
||
.SH DESCRIPTION
|
||
.sp
|
||
Initialize the PMIx client, returning the process identifier assigned
|
||
to this client’s application in the provided \fBpmix_proc_t\fP
|
||
struct. Passing a parameter of NULL for this parameter is allowed if
|
||
the user wishes solely to initialize the PMIx system and does not
|
||
require return of the identifier at that time.
|
||
.sp
|
||
When called, the PMIx client will check for the required connection
|
||
information of the local PMIx server and will establish the
|
||
connection. If the information is not found, or the server connection
|
||
fails, then an appropriate error constant will be returned.
|
||
.sp
|
||
If successful, the function will return \fBPMIX_SUCCESS\fP and will fill
|
||
the provided structure with the server\-assigned namespace and rank of
|
||
the process within the application.
|
||
.sp
|
||
Note that the PMIx client library is referenced counted, and so
|
||
multiple calls to \fBPMIx_Init\fP are allowed. Thus, one way to obtain
|
||
the namespace and rank of the process is to simply call \fBPMIx_Init\fP
|
||
with a non\-NULL parameter.
|
||
.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
|
||
PMIx_Initialized(3),
|
||
\fI\%PMIx_Abort(3)\fP,
|
||
PMIx_Commit(3),
|
||
\fI\%PMIx_Finalize(3)\fP,
|
||
PMIx_Put(3),
|
||
pmiAddInstance(3),
|
||
pmiAddMetric(3)
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.SH COPYRIGHT
|
||
2014-2025, The OpenPMIx Community
|
||
.\" Generated by docutils manpage writer.
|
||
.
|