18.2.232. PMIx_Load_procid

PMIx_Load_procid — Populate a pmix_proc_t(5) with a namespace and rank

18.2.232.1. SYNOPSIS

#include <pmix.h>

void PMIx_Load_procid(pmix_proc_t *p,
                      const char *ns,
                      pmix_rank_t rk);

18.2.232.1.1. Python Syntax

No Python equivalent

18.2.232.2. INPUT PARAMETERS

p: Pointer to the pmix_proc_t(5) structure to be populated. The storage must already exist — it is supplied by the caller.
ns: Pointer to a NULL-terminated namespace string to load into the structure’s nspace field. May be NULL.
rk: The pmix_rank_t(5) value to store in the structure’s rank field.

18.2.232.3. DESCRIPTION

Populate the fields of a pmix_proc_t process identifier. The nspace field is loaded from ns using the same semantics as PMIx_Load_nspace(3): the field is first cleared, then up to PMIX_MAX_NSLEN characters are copied from ns (or the field is left empty if ns is NULL). The rank field is then set to rk.

Unlike PMIx_Proc_load(3), which first constructs the structure (setting the rank to PMIX_RANK_UNDEF) before loading, this routine writes only the nspace and rank fields directly.

18.2.232.4. RETURN VALUE

PMIx_Load_procid returns no value (void).

18.2.232.5. NOTES

PMIx_Load_procid is an OpenPMIx convenience routine and is the backing implementation of the PMIX_LOAD_PROCID macro.