18.2.182. PMIx_Coord_free

PMIx_Coord_free — Release an array of pmix_coord_t(5) structures and its storage.

18.2.182.1. SYNOPSIS

#include <pmix.h>

void PMIx_Coord_free(pmix_coord_t *m, size_t number);

18.2.182.1.1. Python Syntax

No Python equivalent

18.2.182.2. INPUT PARAMETERS

m: Pointer to the array of pmix_coord_t(5) structures to be released, as returned by PMIx_Coord_create(3).
number: Number of structures in the array.

18.2.182.3. DESCRIPTION

Release an array of pmix_coord_t structures that was allocated by PMIx_Coord_create(3). Each of the number elements is destructed (freeing any coord array it holds), and then the storage for the array itself is freed.

If m is NULL the function does nothing.

18.2.182.4. RETURN VALUE

PMIx_Coord_free returns no value (void).

18.2.182.5. NOTES

PMIx_Coord_free frees the array storage itself, so it must only be used on arrays obtained from PMIx_Coord_create(3). To release only the contents of a caller-provided (stack or embedded) structure without freeing its storage, use PMIx_Coord_destruct(3) instead.

The convenience macro PMIX_COORD_FREE wraps this function and additionally sets the caller’s pointer to NULL.