FreeBSD Manual Pages
PMIX_INIT(3) OpenPMIx PMIX_INIT(3) PMIx_Init - Initialize the PMIx Client SYNOPSIS #include <pmix.h> pmix_status_t PMIx_Init(pmix_proc_t *proc); ARGUMENTS • proc: Pointer to a pmix_proc_t object in which the clients namespace and rank are to be returned. DESCRIPTION Initialize the PMIx client, returning the process identifier assigned to this clients application in the provided pmix_proc_t 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. When called, the PMIx client will check for the required connection in- formation 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. If successful, the function will return PMIX_SUCCESS and will fill the provided structure with the server-assigned namespace and rank of the process within the application. Note that the PMIx client library is referenced counted, and so multi- ple calls to PMIx_Init are allowed. Thus, one way to obtain the name- space and rank of the process is to simply call PMIx_Init with a non-NULL parameter. RETURN VALUE Returns PMIX_SUCCESS on success. On error, a negative value correspond- ing to a PMIx errno is returned. ERRORS PMIx errno values are defined in pmix_common.h. SEE ALSO: PMIx_Initialized(3), PMIx_Abort(3), PMIx_Commit(3), PMIx_Finalize(3), PMIx_Put(3), pmiAddInstance(3), pmiAddMetric(3) COPYRIGHT 2014-2025, The OpenPMIx Community Feb 14, 2025 PMIX_INIT(3)
SYNOPSIS | ARGUMENTS | DESCRIPTION | RETURN VALUE | ERRORS | COPYRIGHT
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=PMIx_Init&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>