21.2.168. PMIx_Query_free
PMIx_Query_free — Release an array of
pmix_query_t(5) structures and their contents.
21.2.168.1. SYNOPSIS
#include <pmix.h>
void PMIx_Query_free(pmix_query_t *p, size_t n);
21.2.168.1.1. Python Syntax
No Python equivalent
21.2.168.2. INPUT PARAMETERS
p: Pointer to the array of pmix_query_t(5) structures to be released.n: Number of structures in the array.
21.2.168.3. DESCRIPTION
Release an array of pmix_query_t structures that was
allocated by PMIx_Query_create(3). The function
first destructs each of the n elements — freeing their keys and
qualifiers contents, exactly as PMIx_Query_destruct(3) would — and then frees the storage of the
array itself.
If p is NULL or n is zero, the function does nothing.
21.2.168.4. RETURN VALUE
PMIx_Query_free returns no value (void).
21.2.168.5. NOTES
The PMIX_QUERY_FREE convenience macro is a direct wrapper for this
function; in addition to calling it, the macro sets the caller’s pointer to
NULL.
Use PMIx_Query_free only on storage obtained from
PMIx_Query_create(3). For a caller-provided
(stack or embedded) structure, use PMIx_Query_destruct(3) instead, which releases the contents without
freeing the structure storage.