18.2.165. PMIx_Query_destruct

PMIx_Query_destruct — Release the contents of a pmix_query_t(5) structure.

18.2.165.1. SYNOPSIS

#include <pmix.h>

void PMIx_Query_destruct(pmix_query_t *p);

18.2.165.1.1. Python Syntax

No Python equivalent

18.2.165.2. INPUT PARAMETERS

p: Pointer to the pmix_query_t(5) structure whose contents are to be released.

18.2.165.3. DESCRIPTION

Release the dynamically allocated contents of a pmix_query_t structure. The function frees the keys string array (if present) and frees the array of qualifiers pmix_info_t(5) structures (if present), then resets those pointers to NULL and sets nqual to zero.

PMIx_Query_destruct releases only the payload the structure references; it does not free the storage of the pmix_query_t structure itself. It is therefore the correct counterpart to PMIx_Query_construct(3) for structures whose storage was supplied by the caller (stack or embedded).

18.2.165.4. RETURN VALUE

PMIx_Query_destruct returns no value (void).

18.2.165.5. NOTES

The PMIX_QUERY_DESTRUCT convenience macro is a direct wrapper for this function.

To release an array of query structures allocated by PMIx_Query_create(3) — including the array storage itself — use PMIx_Query_free(3) or PMIx_Query_release(3) instead.