18.2.210. PMIx_Node_pid_free

PMIx_Node_pid_free — Release an array of pmix_node_pid_t(5) structures.

18.2.210.1. SYNOPSIS

#include <pmix.h>

void PMIx_Node_pid_free(pmix_node_pid_t *d, size_t n);

18.2.210.1.1. Python Syntax

No Python equivalent

18.2.210.2. INPUT PARAMETERS

d: Pointer to an array of pmix_node_pid_t(5) structures previously returned by PMIx_Node_pid_create(3).
n: Number of structures in the array — must be the same count that was passed to PMIx_Node_pid_create(3).

18.2.210.3. DESCRIPTION

Release an array of pmix_node_pid_t structures that was allocated by PMIx_Node_pid_create(3). The function destructs the contents of each of the n elements — freeing the hostname payload as if by PMIx_Node_pid_destruct(3) — and then frees the array storage itself.

If d is NULL the function returns without action.

18.2.210.4. RETURN VALUE

PMIx_Node_pid_free returns no value (void).

18.2.210.5. NOTES

PMIx_Node_pid_free is the counterpart to PMIx_Node_pid_create(3). Do not call it on a single structure that was merely constructed with PMIx_Node_pid_construct(3); use PMIx_Node_pid_destruct(3) for that case, since the structure storage was not allocated by the library.