Scroll to navigation

PMIX_ENVAR_FREE(3) OpenPMIx PMIX_ENVAR_FREE(3)

PMIx_Envar_free — Release an array of pmix_envar_t(5) <#man5-pmix-envar-t> structures.

SYNOPSIS

#include <pmix.h>
void PMIx_Envar_free(pmix_envar_t *e, size_t n);


Python Syntax

No Python equivalent

INPUT PARAMETERS

  • e: Pointer to the array of pmix_envar_t(5) <#man5-pmix-envar-t> structures to be released.
  • n: Number of structures in the array.

DESCRIPTION

Release an array of pmix_envar_t <#man5-pmix-envar-t> structures that was previously obtained from PMIx_Envar_create(3) <#man3-pmix-envar-create>. 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.

RETURN VALUE

PMIx_Envar_free returns no value (void).

NOTES

PMIx_Envar_free is the counterpart to PMIx_Envar_create(3) <#man3-pmix-envar-create>. 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) <#man3-pmix-envar-destruct> instead.

See also:

PMIx_Envar_create(3) <#man3-pmix-envar-create>, PMIx_Envar_construct(3) <#man3-pmix-envar-construct>, PMIx_Envar_destruct(3) <#man3-pmix-envar-destruct>, PMIx_Envar_load(3) <#man3-pmix-envar-load>, pmix_envar_t(5) <#man5-pmix-envar-t>


Copyright

2014-2026, OpenPMIx Community

September 27, 2026