18.2.154. PMIx_App_destruct

PMIx_App_destruct — Release the contents of a pmix_app_t(5) structure.

18.2.154.1. SYNOPSIS

#include <pmix.h>

void PMIx_App_destruct(pmix_app_t *p);

18.2.154.1.1. Python Syntax

No Python equivalent

18.2.154.2. INPUT PARAMETERS

p: Pointer to the pmix_app_t(5) structure whose contents are to be released.

18.2.154.3. DESCRIPTION

Release all heap memory referenced by the fields of a pmix_app_t structure. The cmd and cwd strings are freed, the argv and env string arrays are freed, and the info array (if present and ninfo is greater than zero) is freed. Each freed field pointer is reset to NULL and ninfo is reset to zero, leaving the structure safe to reuse or destruct again.

PMIx_App_destruct does not free the storage of the pmix_app_t structure itself. It releases only the payload attached to a structure that was previously initialized with PMIx_App_construct(3).

18.2.154.4. RETURN VALUE

PMIx_App_destruct returns no value (void).

18.2.154.5. NOTES

PMIx_App_destruct is the counterpart of PMIx_App_construct(3). To release an app array that was heap-allocated by PMIx_App_create(3), use PMIx_App_free(3) (which destructs each element and frees the array) or PMIx_App_release(3) for a single app.