Scroll to navigation

PMIX_PROC_INFO_FREE(3) OpenPMIx PMIX_PROC_INFO_FREE(3)

PMIx_Proc_info_free — Release an array of pmix_proc_info_t(5) <#man5-pmix-proc-info-t> structures.

SYNOPSIS

#include <pmix.h>
void PMIx_Proc_info_free(pmix_proc_info_t *p, size_t n);


Python Syntax

No Python equivalent

INPUT PARAMETERS


DESCRIPTION

Destruct each of the n elements of the array — freeing any hostname and executable_name strings held by each element — and then free the array storage itself. This is the counterpart to PMIx_Proc_info_create(3) <#man3-pmix-proc-info-create>.

If p is NULL or n is zero, the function does nothing.

Only pass storage that was heap-allocated by PMIx_Proc_info_create(3) <#man3-pmix-proc-info-create> to this function. A structure that was initialized with PMIx_Proc_info_construct(3) <#man3-pmix-proc-info-construct> on caller-provided memory must be cleared with PMIx_Proc_info_destruct(3) <#man3-pmix-proc-info-destruct> instead — passing it to PMIx_Proc_info_free would attempt to free storage the library did not allocate.

RETURN VALUE

PMIx_Proc_info_free returns no value (void).

NOTES

PMIx_Proc_info_free is an OpenPMIx convenience routine. The corresponding PMIX_PROC_INFO_FREE macro calls this function and then sets the caller’s pointer to NULL.

See also:

PMIx_Proc_info_create(3) <#man3-pmix-proc-info-create>, 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