table of contents
- unstable 7.0.0~rc1-1
| PMIX_GEOMETRY_FREE(3) | OpenPMIx | PMIX_GEOMETRY_FREE(3) |
PMIx_Geometry_free — Release an array of pmix_geometry_t(5) <#man5-pmix-geometry-t> structures.
SYNOPSIS¶
#include <pmix.h> void PMIx_Geometry_free(pmix_geometry_t *g, size_t n);
Python Syntax¶
No Python equivalent
INPUT PARAMETERS¶
- g: Pointer to an array of pmix_geometry_t(5) <#man5-pmix-geometry-t> structures previously returned by PMIx_Geometry_create(3) <#man3-pmix-geometry-create>.
- n: Number of structures in the array — must be the same count that was passed to PMIx_Geometry_create(3) <#man3-pmix-geometry-create>.
DESCRIPTION¶
Release an array of pmix_geometry_t <#man5-pmix-geometry-t> structures that was allocated by PMIx_Geometry_create(3) <#man3-pmix-geometry-create>. 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) <#man3-pmix-geometry-destruct> — and then frees the array storage itself.
If g is NULL the function returns without action.
RETURN VALUE¶
PMIx_Geometry_free returns no value (void).
NOTES¶
PMIx_Geometry_free is the counterpart to PMIx_Geometry_create(3) <#man3-pmix-geometry-create>. Do not call it on a single structure that was merely constructed with PMIx_Geometry_construct(3) <#man3-pmix-geometry-construct>; use PMIx_Geometry_destruct(3) <#man3-pmix-geometry-destruct> for that case, since the structure storage was not allocated by the library.
See also:
Copyright¶
2014-2026, OpenPMIx Community
| September 27, 2026 |