Scroll to navigation

PMIX_PROC_INFO_CREATE(3) OpenPMIx PMIX_PROC_INFO_CREATE(3)

PMIx_Proc_info_create — Allocate and initialize an array of pmix_proc_info_t(5) <#man5-pmix-proc-info-t> structures.

SYNOPSIS

#include <pmix.h>
pmix_proc_info_t* PMIx_Proc_info_create(size_t n);


Python Syntax

No Python equivalent

INPUT PARAMETERS

•
n: Number of pmix_proc_info_t(5) <#man5-pmix-proc-info-t> structures to allocate.

DESCRIPTION

Allocate a contiguous array of n pmix_proc_info_t <#man5-pmix-proc-info-t> structures on the heap and construct each element — zeroing the structure and setting state to PMIX_PROC_STATE_UNDEF — exactly as PMIx_Proc_info_construct(3) <#man3-pmix-proc-info-construct> would.

The returned array is owned by the caller and must be released with PMIx_Proc_info_free(3) <#man3-pmix-proc-info-free>, which destructs each element (freeing any hostname and executable_name strings) and frees the underlying storage.

RETURN VALUE

Returns a pointer to the newly allocated array of pmix_proc_info_t <#man5-pmix-proc-info-t> structures, or NULL if n is zero or the allocation fails.

NOTES

PMIx_Proc_info_create is an OpenPMIx convenience routine. The corresponding PMIX_PROC_INFO_CREATE macro assigns the returned pointer to its first argument and is implemented as a call to this function.

EXAMPLES

Allocate an array of proc info structures and release it when done:

pmix_proc_info_t *pinfo;
size_t ninfo = 2;
pinfo = PMIx_Proc_info_create(ninfo);
/* ... populate and use the array ... */
PMIx_Proc_info_free(pinfo, ninfo);


See also:

PMIx_Proc_info_free(3) <#man3-pmix-proc-info-free>, PMIx_Proc_info_construct(3) <#man3-pmix-proc-info-construct>, PMIx_Proc_info_destruct(3) <#man3-pmix-proc-info-destruct>, pmix_proc_info_t(5) <#man5-pmix-proc-info-t>


Copyright

2014-2026, OpenPMIx Community

September 27, 2026