18.2.160. PMIx_Envar_free

PMIx_Envar_free — Release an array of pmix_envar_t(5) structures.

18.2.160.1. SYNOPSIS

#include <pmix.h>

void PMIx_Envar_free(pmix_envar_t *e, size_t n);

18.2.160.1.1. Python Syntax

No Python equivalent

18.2.160.2. INPUT PARAMETERS

e: Pointer to the array of pmix_envar_t(5) structures to be released.
n: Number of structures in the array.

18.2.160.3. DESCRIPTION

Release an array of pmix_envar_t structures that was previously obtained from PMIx_Envar_create(3). Each of the n elements is destructed — its envar and value strings are freed — and then the array storage itself is freed.

If e is NULL, the call is a no-op.

18.2.160.4. RETURN VALUE

PMIx_Envar_free returns no value (void).

18.2.160.5. NOTES

PMIx_Envar_free is the counterpart to PMIx_Envar_create(3). It both destructs the contents of each element and frees the block of memory holding the array. To release only the contents of a single caller-owned structure without freeing its storage, use PMIx_Envar_destruct(3) instead.