18.2.145. PMIx_Proc_info_free

PMIx_Proc_info_free — Release an array of pmix_proc_info_t(5) structures.

18.2.145.1. SYNOPSIS

#include <pmix.h>

void PMIx_Proc_info_free(pmix_proc_info_t *p, size_t n);

18.2.145.1.1. Python Syntax

No Python equivalent

18.2.145.2. INPUT PARAMETERS

p: Pointer to the array of pmix_proc_info_t(5) structures to be released, as returned by PMIx_Proc_info_create(3).
n: Number of structures in the array.

18.2.145.3. 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).

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) to this function. A structure that was initialized with PMIx_Proc_info_construct(3) on caller-provided memory must be cleared with PMIx_Proc_info_destruct(3) instead — passing it to PMIx_Proc_info_free would attempt to free storage the library did not allocate.

18.2.145.4. RETURN VALUE

PMIx_Proc_info_free returns no value (void).

18.2.145.5. 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.