18.2.148. PMIx_Proc_destruct

PMIx_Proc_destruct — Clear the contents of a pmix_proc_t(5) structure.

18.2.148.1. SYNOPSIS

#include <pmix.h>

void PMIx_Proc_destruct(pmix_proc_t *p);

18.2.148.1.1. Python Syntax

No Python equivalent

18.2.148.2. INPUT PARAMETERS

p: Pointer to the pmix_proc_t(5) structure to be cleared. The storage for the structure itself is not freed.

18.2.148.3. DESCRIPTION

Reset the contents of a pmix_proc_t structure. A pmix_proc_t carries no heap-allocated payload — its nspace field is a fixed-size character array and its rank is a scalar — so this function performs the same reset as PMIx_Proc_construct(3): it zeroes the nspace field and sets rank to PMIX_RANK_UNDEF. No memory is freed.

PMIx_Proc_destruct is the counterpart to PMIx_Proc_construct(3) and releases only the contents of the structure, not the structure storage itself. To release an array of proc structures that was heap-allocated by PMIx_Proc_create(3), use PMIx_Proc_free(3) instead.

18.2.148.4. RETURN VALUE

PMIx_Proc_destruct returns no value (void).

18.2.148.5. NOTES

PMIx_Proc_destruct is an OpenPMIx convenience routine. The corresponding PMIX_PROC_DESTRUCT macro is implemented as a direct call to this function. Because a pmix_proc_t owns no allocated memory, calling this function is functionally equivalent to re-constructing the structure.