18.2.194. PMIx_Topology_free
PMIx_Topology_free — Release an array of
pmix_topology_t(5) structures.
18.2.194.1. SYNOPSIS
#include <pmix.h>
void PMIx_Topology_free(pmix_topology_t *t, size_t n);
18.2.194.1.1. Python Syntax
No Python equivalent
18.2.194.2. INPUT PARAMETERS
t: Pointer to an array of pmix_topology_t(5) structures previously returned by PMIx_Topology_create(3).n: Number of structures in the array — must be the same count that was passed to PMIx_Topology_create(3).
18.2.194.3. DESCRIPTION
Release an array of pmix_topology_t structures
that was allocated by PMIx_Topology_create(3). The function destructs the contents of each of
the n elements — releasing any embedded hwloc topology object and
source string as if by PMIx_Topology_destruct(3) — and then frees the array storage itself.
If t is NULL the function returns without action.
18.2.194.4. RETURN VALUE
PMIx_Topology_free returns no value (void).
18.2.194.5. NOTES
PMIx_Topology_free is the counterpart to PMIx_Topology_create(3). Do not call it on a single structure that was
merely constructed with PMIx_Topology_construct(3); use PMIx_Topology_destruct(3) for that case, since the structure storage was
not allocated by the library.