18.2.144. PMIx_Proc_info_destruct

PMIx_Proc_info_destruct — Release the contents of a pmix_proc_info_t(5) structure.

18.2.144.1. SYNOPSIS

#include <pmix.h>

void PMIx_Proc_info_destruct(pmix_proc_info_t *p);

18.2.144.1.1. Python Syntax

No Python equivalent

18.2.144.2. INPUT PARAMETERS

p: Pointer to the pmix_proc_info_t(5) structure whose contents are to be released. The storage for the structure itself is not freed.

18.2.144.3. DESCRIPTION

Release the heap-allocated payload of a pmix_proc_info_t structure. If the hostname or executable_name fields are non-NULL, the strings they point to are freed. The structure is then re-initialized to its constructed state — zeroed, with state set to PMIX_PROC_STATE_UNDEF — exactly as PMIx_Proc_info_construct(3) would leave it.

PMIx_Proc_info_destruct is the counterpart to PMIx_Proc_info_construct(3) and releases only the contents of the structure, not the structure storage itself. To release an array of proc info structures that was heap-allocated by PMIx_Proc_info_create(3), use PMIx_Proc_info_free(3) instead.

18.2.144.4. RETURN VALUE

PMIx_Proc_info_destruct returns no value (void).

18.2.144.5. NOTES

PMIx_Proc_info_destruct is an OpenPMIx convenience routine. The corresponding PMIX_PROC_INFO_DESTRUCT macro is implemented as a direct call to this function.