18.2.189. PMIx_Geometry_destruct

PMIx_Geometry_destruct — Release the contents of a pmix_geometry_t(5) structure.

18.2.189.1. SYNOPSIS

#include <pmix.h>

void PMIx_Geometry_destruct(pmix_geometry_t *g);

18.2.189.1.1. Python Syntax

No Python equivalent

18.2.189.2. INPUT PARAMETERS

g: Pointer to the pmix_geometry_t(5) structure whose contents are to be released.

18.2.189.3. DESCRIPTION

Release the dynamically allocated payload held within a pmix_geometry_t structure. The function frees the uuid and osname strings (setting each pointer to NULL) and releases the coordinates array via the coordinate-free path.

PMIx_Geometry_destruct releases only the contents of the structure; it does not free the storage of the pmix_geometry_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.189.4. RETURN VALUE

PMIx_Geometry_destruct returns no value (void).

18.2.189.5. NOTES

PMIx_Geometry_destruct is the counterpart to PMIx_Geometry_construct(3). To release an array of structures that was allocated by PMIx_Geometry_create(3), including the array storage itself, use PMIx_Geometry_free(3) instead.