Scroll to navigation

PMIX_RESOURCE_UNIT_DESTRUCT(3) OpenPMIx PMIX_RESOURCE_UNIT_DESTRUCT(3)

PMIx_Resource_unit_destruct — Release the contents of a pmix_resource_unit_t(5) <#man5-pmix-resource-unit-t> structure.

SYNOPSIS

#include <pmix.h>
void PMIx_Resource_unit_destruct(pmix_resource_unit_t *d);


Python Syntax

No Python equivalent

INPUT PARAMETERS

•
d: Pointer to the pmix_resource_unit_t(5) <#man5-pmix-resource-unit-t> structure whose contents are to be released.

DESCRIPTION

Release any dynamically allocated memory held by a pmix_resource_unit_t <#man5-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 <#man5-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) <#man3-pmix-resource-unit-construct> 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) <#man3-pmix-resource-unit-create>, use PMIx_Resource_unit_free(3) <#man3-pmix-resource-unit-free> instead, which destructs each element and frees the array storage.

RETURN VALUE

PMIx_Resource_unit_destruct returns no value (void).

See also:

PMIx_Resource_unit_construct(3) <#man3-pmix-resource-unit-construct>, PMIx_Resource_unit_create(3) <#man3-pmix-resource-unit-create>, PMIx_Resource_unit_free(3) <#man3-pmix-resource-unit-free>, pmix_resource_unit_t(5) <#man5-pmix-resource-unit-t>


Copyright

2014-2026, OpenPMIx Community

September 27, 2026