SYNOPSIS¶

#include <pmix.h>
pmix_envar_t* PMIx_Envar_create(size_t n);

INPUT PARAMETERS¶

DESCRIPTION¶

Allocate a contiguous array of n pmix_envar_t <#man5-pmix-envar-t> structures on the heap and construct each element (see PMIx_Envar_construct(3) <#man3-pmix-envar-construct>) so that every envar and value pointer is NULL and every separator is '\0'. A pointer to the first element of the array is returned.

If n is zero, no allocation is performed and NULL is returned.

RETURN VALUE¶

Returns a pointer to the newly allocated array of pmix_envar_t <#man5-pmix-envar-t> structures, or NULL if n is zero or the allocation failed.

NOTES¶

An array obtained from PMIx_Envar_create must be released with PMIx_Envar_free(3) <#man3-pmix-envar-free>, which both destructs the contents of each element and frees the array storage itself. Do not release such an array element-by-element with PMIx_Envar_destruct(3) <#man3-pmix-envar-destruct>, as that would leave the array storage leaked.

EXAMPLES¶

Create and later free an array:

pmix_envar_t *envars;
envars = PMIx_Envar_create(4);
/* ... use the array ... */
PMIx_Envar_free(envars, 4);

See also:

Copyright¶

2014-2026, OpenPMIx Community