21.2.192. PMIx_Geometry_free

PMIx_Geometry_free — Release an array of pmix_geometry_t(5) structures.

21.2.192.1. SYNOPSIS

#include <pmix.h>

void PMIx_Geometry_free(pmix_geometry_t *g, size_t n);

21.2.192.1.1. Python Syntax

No Python equivalent

21.2.192.2. INPUT PARAMETERS

21.2.192.3. DESCRIPTION

Release an array of pmix_geometry_t structures that was allocated by PMIx_Geometry_create(3). The function destructs the contents of each of the n elements — freeing the uuid, osname, and coordinates payloads as if by PMIx_Geometry_destruct(3) — and then frees the array storage itself.

If g is NULL the function returns without action.

21.2.192.4. RETURN VALUE

PMIx_Geometry_free returns no value (void).

21.2.192.5. NOTES

PMIx_Geometry_free is the counterpart to PMIx_Geometry_create(3). Do not call it on a single structure that was merely constructed with PMIx_Geometry_construct(3); use PMIx_Geometry_destruct(3) for that case, since the structure storage was not allocated by the library.