18.2.206. PMIx_Endpoint_free

PMIx_Endpoint_free — Release an array of pmix_endpoint_t(5) structures allocated by PMIx_Endpoint_create(3).

18.2.206.1. SYNOPSIS

#include <pmix.h>

void PMIx_Endpoint_free(pmix_endpoint_t *e, size_t n);

18.2.206.1.1. Python Syntax

No Python equivalent

18.2.206.2. INPUT PARAMETERS

e: Pointer to the array of pmix_endpoint_t(5) structures to be released. May be NULL, in which case the call is a no-op.
n: Number of structures in the array.

18.2.206.3. DESCRIPTION

Release an array of pmix_endpoint_t structures that was previously allocated by PMIx_Endpoint_create(3). The function destructs each of the n elements — freeing the uuid and osname strings and the endpt byte-object payload of every member — and then frees the array storage itself. If e is NULL the function returns immediately.

Use this routine only on array storage that the library allocated. A single structure that was initialized with PMIx_Endpoint_construct(3) must be released with PMIx_Endpoint_destruct(3) instead, since its storage was provided by the caller.

18.2.206.4. RETURN VALUE

PMIx_Endpoint_free returns no value (void).

18.2.206.5. NOTES

Unlike PMIx_Endpoint_destruct(3), which releases only the contents of a structure, PMIx_Endpoint_free also frees the memory occupied by the array itself.