18.2.181. PMIx_Coord_destruct

PMIx_Coord_destruct — Release the contents of a pmix_coord_t(5) structure.

18.2.181.1. SYNOPSIS

#include <pmix.h>

void PMIx_Coord_destruct(pmix_coord_t *m);

18.2.181.1.1. Python Syntax

No Python equivalent

18.2.181.2. INPUT PARAMETERS

m: Pointer to the pmix_coord_t(5) structure whose contents are to be released.

18.2.181.3. DESCRIPTION

Release the contents of a pmix_coord_t. The view field is reset to PMIX_COORD_VIEW_UNDEF. If the coord pointer is non-NULL, the coordinate array it references is freed, the coord pointer is reset to NULL, and the dims field is set to zero.

Only the contents are released; the storage for the structure itself is not freed. This routine is therefore the correct counterpart to PMIx_Coord_construct(3) for caller-provided (stack or embedded) structures.

18.2.181.4. RETURN VALUE

PMIx_Coord_destruct returns no value (void).

18.2.181.5. NOTES

To release an array of coordinate structures obtained from PMIx_Coord_create(3), including the array storage itself, use PMIx_Coord_free(3) instead.

The convenience macro PMIX_COORD_DESTRUCT is provided as a direct wrapper around this function.