21.2.151. PMIx_Proc_free
PMIx_Proc_free — Release an array of
pmix_proc_t(5) structures.
21.2.151.1. SYNOPSIS
#include <pmix.h>
void PMIx_Proc_free(pmix_proc_t *p, size_t n);
21.2.151.1.1. Python Syntax
No Python equivalent
21.2.151.2. INPUT PARAMETERS
p: Pointer to the array of pmix_proc_t(5) structures to be released, as returned by PMIx_Proc_create(3).n: Number of structures in the array.
21.2.151.3. DESCRIPTION
Destruct each of the n elements of the array and then free the array
storage itself. This is the counterpart to
PMIx_Proc_create(3).
If p is NULL or n is zero, the function does nothing.
Only pass storage that was heap-allocated by
PMIx_Proc_create(3) to this function. A structure
that was initialized with PMIx_Proc_construct(3) on caller-provided memory must be cleared with
PMIx_Proc_destruct(3) instead — passing it
to PMIx_Proc_free would attempt to free storage the library did not
allocate.
21.2.151.4. RETURN VALUE
PMIx_Proc_free returns no value (void).
21.2.151.5. NOTES
PMIx_Proc_free is an OpenPMIx convenience routine. The corresponding
PMIX_PROC_FREE macro calls this function and then sets the caller’s pointer
to NULL.