table of contents
- unstable 7.0.0~rc1-1
| PMIX_NODE_PID_FREE(3) | OpenPMIx | PMIX_NODE_PID_FREE(3) |
PMIx_Node_pid_free — Release an array of pmix_node_pid_t(5) <#man5-pmix-node-pid-t> structures.
SYNOPSIS¶
#include <pmix.h> void PMIx_Node_pid_free(pmix_node_pid_t *d, size_t n);
Python Syntax¶
No Python equivalent
INPUT PARAMETERS¶
- d: Pointer to an array of pmix_node_pid_t(5) <#man5-pmix-node-pid-t> structures previously returned by PMIx_Node_pid_create(3) <#man3-pmix-node-pid-create>.
- n: Number of structures in the array — must be the same count that was passed to PMIx_Node_pid_create(3) <#man3-pmix-node-pid-create>.
DESCRIPTION¶
Release an array of pmix_node_pid_t <#man5-pmix-node-pid-t> structures that was allocated by PMIx_Node_pid_create(3) <#man3-pmix-node-pid-create>. The function destructs the contents of each of the n elements — freeing the hostname payload as if by PMIx_Node_pid_destruct(3) <#man3-pmix-node-pid-destruct> — and then frees the array storage itself.
If d is NULL the function returns without action.
RETURN VALUE¶
PMIx_Node_pid_free returns no value (void).
NOTES¶
PMIx_Node_pid_free is the counterpart to PMIx_Node_pid_create(3) <#man3-pmix-node-pid-create>. Do not call it on a single structure that was merely constructed with PMIx_Node_pid_construct(3) <#man3-pmix-node-pid-construct>; use PMIx_Node_pid_destruct(3) <#man3-pmix-node-pid-destruct> for that case, since the structure storage was not allocated by the library.
See also:
Copyright¶
2014-2026, OpenPMIx Community
| September 27, 2026 |