18.2.218. PMIx_Regex2_destruct

PMIx_Regex2_destruct — Release the contents of a pmix_regex2_t(5) structure.

18.2.218.1. SYNOPSIS

#include <pmix.h>

void PMIx_Regex2_destruct(pmix_regex2_t *d);

18.2.218.1.1. Python Syntax

No Python equivalent

18.2.218.2. INPUT PARAMETERS

d: Pointer to the pmix_regex2_t structure whose contents are to be released.

18.2.218.3. DESCRIPTION

Release the payload held by a pmix_regex2_t. If the type pointer is non-NULL it is freed; likewise, if the bytes pointer is non-NULL it is freed. The storage for the structure itself is not freed — that remains the responsibility of the caller.

PMIx_Regex2_destruct is the counterpart to PMIx_Regex2_construct(3) and should be used to clean up any structure that was constructed on caller-provided storage.

18.2.218.4. RETURN VALUE

PMIx_Regex2_destruct returns no value (void).

18.2.218.5. NOTES

To release an array of structures that was obtained from PMIx_Regex2_create(3) — which also frees the array storage itself — use PMIx_Regex2_free(3) instead.