18.2.193. PMIx_Topology_destruct

PMIx_Topology_destruct — Release the contents of a pmix_topology_t(5) structure.

18.2.193.1. SYNOPSIS

#include <pmix.h>

void PMIx_Topology_destruct(pmix_topology_t *topo);

18.2.193.1.1. Python Syntax

No Python equivalent

18.2.193.2. INPUT PARAMETERS

topo: Pointer to the pmix_topology_t(5) structure whose contents are to be released.

18.2.193.3. DESCRIPTION

Release the internal payload held within a pmix_topology_t structure. When the structure describes an hwloc topology (its source string begins with "hwloc"), the function destroys the embedded hwloc topology object, frees the source string, and sets both pointers to NULL. Structures with any other source (or none) are left untouched, since their topology payload is not owned by the library.

PMIx_Topology_destruct releases only the contents of the structure; it does not free the storage of the pmix_topology_t structure itself. When the structure was allocated on the stack or embedded in another object, that storage is reclaimed by its owner.

18.2.193.4. RETURN VALUE

PMIx_Topology_destruct returns no value (void).

18.2.193.5. NOTES

PMIx_Topology_destruct is the counterpart to PMIx_Topology_construct(3). To release an array of structures that was allocated by PMIx_Topology_create(3), including the array storage itself, use PMIx_Topology_free(3) instead.