18.2.219. PMIx_Regex2_free

PMIx_Regex2_free — Release an array of pmix_regex2_t(5) structures.

18.2.219.1. SYNOPSIS

#include <pmix.h>

void PMIx_Regex2_free(pmix_regex2_t *d, size_t n);

18.2.219.1.1. Python Syntax

No Python equivalent

18.2.219.2. INPUT PARAMETERS

  • d: Pointer to the array of pmix_regex2_t structures to be released.

  • n: Number of structures in the array.

18.2.219.3. DESCRIPTION

Release an array of pmix_regex2_t structures that was previously obtained from PMIx_Regex2_create(3). Each of the n elements is destructed — its type and bytes allocations are freed — and then the array storage itself is freed.

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

18.2.219.4. RETURN VALUE

PMIx_Regex2_free returns no value (void).

18.2.219.5. NOTES

PMIx_Regex2_free is the counterpart to PMIx_Regex2_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_Regex2_destruct(3) instead.