18.2.186. PMIx_Cpuset_free

PMIx_Cpuset_free — Release an array of pmix_cpuset_t(5) structures and its storage.

18.2.186.1. SYNOPSIS

#include <pmix.h>

void PMIx_Cpuset_free(pmix_cpuset_t *c, size_t n);

18.2.186.1.1. Python Syntax

No Python equivalent

18.2.186.2. INPUT PARAMETERS

c: Pointer to the array of pmix_cpuset_t(5) structures to be released, as returned by PMIx_Cpuset_create(3).
n: Number of structures in the array.

18.2.186.3. DESCRIPTION

Release an array of pmix_cpuset_t structures that was allocated by PMIx_Cpuset_create(3). Each of the n elements is destructed (freeing its source string and bitmap), and then the storage for the array itself is freed.

If c is NULL the function does nothing.

18.2.186.4. RETURN VALUE

PMIx_Cpuset_free returns no value (void).

18.2.186.5. NOTES

PMIx_Cpuset_free frees the array storage itself, so it must only be used on arrays obtained from PMIx_Cpuset_create(3). To release only the contents of a caller-provided (stack or embedded) structure without freeing its storage, use PMIx_Cpuset_destruct(3) instead.

The convenience macro PMIX_CPUSET_FREE wraps this function and additionally sets the caller’s pointer to NULL.