21.2.142. PMIx_Data_array_free

PMIx_Data_array_free — Release a pmix_data_array_t(5) allocated by PMIx_Data_array_create(3).

21.2.142.1. SYNOPSIS

#include <pmix.h>

void PMIx_Data_array_free(pmix_data_array_t *p);

21.2.142.1.1. Python Syntax

No Python equivalent

21.2.142.2. INPUT PARAMETERS

p: Pointer to the pmix_data_array_t(5) structure to be released.

21.2.142.3. DESCRIPTION

Release a pmix_data_array_t that was previously allocated by PMIx_Data_array_create(3). The backing element array (and any per-element payload) is destructed via PMIx_Data_array_destruct(3), and then the pmix_data_array_t structure itself is freed.

If p is NULL, the function does nothing.

21.2.142.4. RETURN VALUE

PMIx_Data_array_free returns no value (void).

21.2.142.5. NOTES

PMIx_Data_array_free is the counterpart of PMIx_Data_array_create(3). Use it only on a structure that the library allocated. For a caller-provided structure that was merely constructed with PMIx_Data_array_construct(3), use PMIx_Data_array_destruct(3) instead — calling PMIx_Data_array_free on such a structure would attempt to free storage the library did not allocate.