18.2.209. PMIx_Node_pid_destruct

PMIx_Node_pid_destruct — Release the contents of a pmix_node_pid_t(5) structure.

18.2.209.1. SYNOPSIS

#include <pmix.h>

void PMIx_Node_pid_destruct(pmix_node_pid_t *d);

18.2.209.1.1. Python Syntax

No Python equivalent

18.2.209.2. INPUT PARAMETERS

d: Pointer to the pmix_node_pid_t(5) structure whose contents are to be released.

18.2.209.3. DESCRIPTION

Release the dynamically allocated payload held within a pmix_node_pid_t structure. The function frees the hostname string if one is present.

PMIx_Node_pid_destruct releases only the contents of the structure; it does not free the storage of the pmix_node_pid_t structure itself. When the structure was allocated on the stack or embedded in another object, that storage is reclaimed by its owner.

18.2.209.4. RETURN VALUE

PMIx_Node_pid_destruct returns no value (void).

18.2.209.5. NOTES

PMIx_Node_pid_destruct is the counterpart to PMIx_Node_pid_construct(3). To release an array of structures that was allocated by PMIx_Node_pid_create(3), including the array storage itself, use PMIx_Node_pid_free(3) instead.