18.2.213. PMIx_Resource_unit_destruct

PMIx_Resource_unit_destruct — Release the contents of a pmix_resource_unit_t(5) structure.

18.2.213.1. SYNOPSIS

#include <pmix.h>

void PMIx_Resource_unit_destruct(pmix_resource_unit_t *d);

18.2.213.1.1. Python Syntax

No Python equivalent

18.2.213.2. INPUT PARAMETERS

d: Pointer to the pmix_resource_unit_t(5) structure whose contents are to be released.

18.2.213.3. DESCRIPTION

Release any dynamically allocated memory held by a pmix_resource_unit_t structure. The storage for the structure itself is not freed, since that storage was provided by the caller.

A pmix_resource_unit_t contains only scalar fields (a type and a count) and owns no heap-allocated payload, so this routine currently performs no work. It is provided for symmetry with PMIx_Resource_unit_construct(3) and so that correct calling code remains valid should the structure gain owned resources in a future release. Well-behaved code should continue to call it.

To release an array of structures allocated by PMIx_Resource_unit_create(3), use PMIx_Resource_unit_free(3) instead, which destructs each element and frees the array storage.

18.2.213.4. RETURN VALUE

PMIx_Resource_unit_destruct returns no value (void).