Scroll to navigation

PMIX_PROC_INFO_CONSTRUCT(3) OpenPMIx PMIX_PROC_INFO_CONSTRUCT(3)

PMIx_Proc_info_construct — Initialize a caller-provided pmix_proc_info_t(5) <#man5-pmix-proc-info-t> structure.

SYNOPSIS

#include <pmix.h>
void PMIx_Proc_info_construct(pmix_proc_info_t *p);


Python Syntax

No Python equivalent

INPUT PARAMETERS

•
p: Pointer to the pmix_proc_info_t(5) <#man5-pmix-proc-info-t> structure to be initialized. The storage for the structure itself must already exist (caller supplied, typically declared on the stack or embedded within another object).

DESCRIPTION

Initialize the memory of a pmix_proc_info_t <#man5-pmix-proc-info-t> that the caller has already allocated. The function zeroes the entire structure — clearing the embedded proc identifier, the hostname and executable_name pointers, the pid, and the exit_code — and sets the state field to PMIX_PROC_STATE_UNDEF. No heap memory is allocated.

Because PMIx_Proc_info_construct operates on caller-provided storage, it must be paired with PMIx_Proc_info_destruct(3) <#man3-pmix-proc-info-destruct> to release any payload (such as the hostname or executable_name strings) the structure subsequently acquires. Do not pass a constructed (as opposed to created) structure to PMIx_Proc_info_free(3) <#man3-pmix-proc-info-free>, as that would attempt to free storage the library did not allocate.

RETURN VALUE

PMIx_Proc_info_construct returns no value (void).

NOTES

PMIx_Proc_info_construct is an OpenPMIx convenience routine. The corresponding PMIX_PROC_INFO_CONSTRUCT macro is implemented as a direct call to this function.

EXAMPLES

Construct a structure:

pmix_proc_info_t pinfo;
PMIx_Proc_info_construct(&pinfo);


See also:

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


Copyright

2014-2026, OpenPMIx Community

September 27, 2026