18.2.190. PMIx_Geometry_free
PMIx_Geometry_free — Release an array of
pmix_geometry_t(5) structures.
18.2.190.1. SYNOPSIS
#include <pmix.h>
void PMIx_Geometry_free(pmix_geometry_t *g, size_t n);
18.2.190.1.1. Python Syntax
No Python equivalent
18.2.190.2. INPUT PARAMETERS
g: Pointer to an array of pmix_geometry_t(5) structures previously returned by PMIx_Geometry_create(3).n: Number of structures in the array — must be the same count that was passed to PMIx_Geometry_create(3).
18.2.190.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.
18.2.190.4. RETURN VALUE
PMIx_Geometry_free returns no value (void).
18.2.190.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.