18.2.156. PMIx_App_release

PMIx_App_release — Release a single pmix_app_t(5) structure allocated by PMIx_App_create(3).

18.2.156.1. SYNOPSIS

#include <pmix.h>

void PMIx_App_release(pmix_app_t *p);

18.2.156.1.1. Python Syntax

No Python equivalent

18.2.156.2. INPUT PARAMETERS

p: Pointer to the single pmix_app_t(5) structure to be released.

18.2.156.3. DESCRIPTION

Release a single heap-allocated pmix_app_t structure. The structure’s payload (cmd, argv, env, cwd, and info) is destructed and then the storage for the structure itself is freed. PMIx_App_release is exactly equivalent to calling PMIx_App_free(p, 1).

If p is NULL, the function does nothing.

18.2.156.4. RETURN VALUE

PMIx_App_release returns no value (void).

18.2.156.5. NOTES

Use PMIx_App_release only for a structure that the library allocated (e.g., via PMIx_App_create(3) with a count of one). Do not call it on a caller-provided structure that was merely constructed with PMIx_App_construct(3); use PMIx_App_destruct(3) for that case.