18.2.167. PMIx_Query_release

PMIx_Query_release — Release a single pmix_query_t(5) structure and its contents.

18.2.167.1. SYNOPSIS

#include <pmix.h>

void PMIx_Query_release(pmix_query_t *p);

18.2.167.1.1. Python Syntax

No Python equivalent

18.2.167.2. INPUT PARAMETERS

p: Pointer to the single pmix_query_t(5) structure to be released.

18.2.167.3. DESCRIPTION

Release a single heap-allocated pmix_query_t structure. The function destructs the structure — freeing its keys and qualifiers contents — and then frees the storage of the structure itself. It is exactly equivalent to calling PMIx_Query_free(3) with a count of 1.

If p is NULL, the function does nothing.

18.2.167.4. RETURN VALUE

PMIx_Query_release returns no value (void).

18.2.167.5. NOTES

The PMIX_QUERY_RELEASE convenience macro is a direct wrapper for this function; in addition to calling it, the macro sets the caller’s pointer to NULL.

PMIx_Query_release frees the structure storage and must therefore be used only on storage the library allocated (for example, the single-element array returned by PMIx_Query_create(3) with n == 1). For a caller-provided (stack or embedded) structure, use PMIx_Query_destruct(3) instead.