Scroll to navigation

PMIX_ENVAR_DESTRUCT(3) OpenPMIx PMIX_ENVAR_DESTRUCT(3)

PMIx_Envar_destruct — Release the contents of a pmix_envar_t(5) <#man5-pmix-envar-t> structure.

SYNOPSIS

#include <pmix.h>
void PMIx_Envar_destruct(pmix_envar_t *e);


Python Syntax

No Python equivalent

INPUT PARAMETERS

•
e: Pointer to the pmix_envar_t(5) <#man5-pmix-envar-t> structure whose contents are to be released.

DESCRIPTION

Release the payload held by a pmix_envar_t <#man5-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) <#man3-pmix-envar-construct> and should be used to clean up any structure that was constructed on caller-provided storage.

RETURN VALUE

PMIx_Envar_destruct returns no value (void).

NOTES

To release an array of structures that was obtained from PMIx_Envar_create(3) <#man3-pmix-envar-create> — which also frees the array storage itself — use PMIx_Envar_free(3) <#man3-pmix-envar-free> instead.

See also:

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


Copyright

2014-2026, OpenPMIx Community

September 27, 2026