Scroll to navigation

PMIX_QUERY_FREE(3) OpenPMIx PMIX_QUERY_FREE(3)

PMIx_Query_free — Release an array of pmix_query_t(5) <#man5-pmix-query-t> structures and their contents.

SYNOPSIS

#include <pmix.h>
void PMIx_Query_free(pmix_query_t *p, size_t n);


Python Syntax

No Python equivalent

INPUT PARAMETERS

  • p: Pointer to the array of pmix_query_t(5) <#man5-pmix-query-t> structures to be released.
  • n: Number of structures in the array.

DESCRIPTION

Release an array of pmix_query_t <#man5-pmix-query-t> structures that was allocated by PMIx_Query_create(3) <#man3-pmix-query-create>. The function first destructs each of the n elements — freeing their keys and qualifiers contents, exactly as PMIx_Query_destruct(3) <#man3-pmix-query-destruct> would — and then frees the storage of the array itself.

If p is NULL or n is zero, the function does nothing.

RETURN VALUE

PMIx_Query_free returns no value (void).

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) <#man3-pmix-query-create>. For a caller-provided (stack or embedded) structure, use PMIx_Query_destruct(3) <#man3-pmix-query-destruct> instead, which releases the contents without freeing the structure storage.

See also:

PMIx_Query_construct(3) <#man3-pmix-query-construct>, PMIx_Query_destruct(3) <#man3-pmix-query-destruct>, PMIx_Query_create(3) <#man3-pmix-query-create>, PMIx_Query_release(3) <#man3-pmix-query-release>, PMIx_Query_qualifiers_create(3) <#man3-pmix-query-qualifiers-create>, pmix_query_t(5) <#man5-pmix-query-t>


Copyright

2014-2026, OpenPMIx Community

September 27, 2026