18.2.159. PMIx_Envar_destruct

PMIx_Envar_destruct — Release the contents of a pmix_envar_t(5) structure.

18.2.159.1. SYNOPSIS

#include <pmix.h>

void PMIx_Envar_destruct(pmix_envar_t *e);

18.2.159.1.1. Python Syntax

No Python equivalent

18.2.159.2. INPUT PARAMETERS

e: Pointer to the pmix_envar_t(5) structure whose contents are to be released.

18.2.159.3. DESCRIPTION

Release the payload held by a pmix_envar_t. If the envar string pointer is non-NULL it is freed and reset to NULL; likewise for the value string pointer. The storage for the structure itself is not freed — that remains the responsibility of the caller.

PMIx_Envar_destruct is the counterpart to PMIx_Envar_construct(3) and should be used to clean up any structure that was constructed on caller-provided storage.

18.2.159.4. RETURN VALUE

PMIx_Envar_destruct returns no value (void).

18.2.159.5. NOTES

To release an array of structures that was obtained from PMIx_Envar_create(3) — which also frees the array storage itself — use PMIx_Envar_free(3) instead.