18.2.185. PMIx_Cpuset_destruct

PMIx_Cpuset_destruct — Release the contents of a pmix_cpuset_t(5) structure.

18.2.185.1. SYNOPSIS

#include <pmix.h>

void PMIx_Cpuset_destruct(pmix_cpuset_t *cpuset);

18.2.185.1.1. Python Syntax

No Python equivalent

18.2.185.2. INPUT PARAMETERS

cpuset: Pointer to the pmix_cpuset_t(5) structure whose contents are to be released.

18.2.185.3. DESCRIPTION

Release the contents of a pmix_cpuset_t. The source string and the bitmap object are freed via the underlying hardware-locality (HWLOC) support, and the corresponding fields are cleared.

Only the contents are released; the storage for the structure itself is not freed. This routine is therefore the correct counterpart to PMIx_Cpuset_construct(3) for caller-provided (stack or embedded) structures.

18.2.185.4. RETURN VALUE

PMIx_Cpuset_destruct returns no value (void).

18.2.185.5. NOTES

To release an array of cpuset structures obtained from PMIx_Cpuset_create(3), including the array storage itself, use PMIx_Cpuset_free(3) instead.

The convenience macro PMIX_CPUSET_DESTRUCT is provided as a direct wrapper around this function.