18.2.205. PMIx_Endpoint_destruct
PMIx_Endpoint_destruct — Release the contents of a
pmix_endpoint_t(5) structure.
18.2.205.1. SYNOPSIS
#include <pmix.h>
void PMIx_Endpoint_destruct(pmix_endpoint_t *e);
18.2.205.1.1. Python Syntax
No Python equivalent
18.2.205.2. INPUT PARAMETERS
e: Pointer to the pmix_endpoint_t(5) structure whose contents are to be released.
18.2.205.3. DESCRIPTION
Release any heap memory referenced by the fields of a
pmix_endpoint_t structure. Specifically, the
uuid and osname strings and the bytes buffer of the embedded
endpt byte object are freed if they are non-NULL. The storage for the
structure itself is not freed — that remains the responsibility of
the caller, since a constructed structure occupies caller-provided storage.
PMIx_Endpoint_destruct is the counterpart to
PMIx_Endpoint_construct(3) and should be
used on any structure that was initialized with it. To release an array of
structures that was allocated by
PMIx_Endpoint_create(3), use
PMIx_Endpoint_free(3) instead, which both
destructs the contents and frees the array storage.
18.2.205.4. RETURN VALUE
PMIx_Endpoint_destruct returns no value (void).