Scroll to navigation

PMIX_ENDPOINT_DESTRUCT(3) OpenPMIx PMIX_ENDPOINT_DESTRUCT(3)

PMIx_Endpoint_destruct — Release the contents of a pmix_endpoint_t(5) <#man5-pmix-endpoint-t> structure.

SYNOPSIS

#include <pmix.h>
void PMIx_Endpoint_destruct(pmix_endpoint_t *e);


Python Syntax

No Python equivalent

INPUT PARAMETERS

•
e: Pointer to the pmix_endpoint_t(5) <#man5-pmix-endpoint-t> structure whose contents are to be released.

DESCRIPTION

Release any heap memory referenced by the fields of a pmix_endpoint_t <#man5-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) <#man3-pmix-endpoint-construct> 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) <#man3-pmix-endpoint-create>, use PMIx_Endpoint_free(3) <#man3-pmix-endpoint-free> instead, which both destructs the contents and frees the array storage.

RETURN VALUE

PMIx_Endpoint_destruct returns no value (void).

See also:

PMIx_Endpoint_construct(3) <#man3-pmix-endpoint-construct>, PMIx_Endpoint_create(3) <#man3-pmix-endpoint-create>, PMIx_Endpoint_free(3) <#man3-pmix-endpoint-free>, pmix_endpoint_t(5) <#man5-pmix-endpoint-t>


Copyright

2014-2026, OpenPMIx Community

September 27, 2026