18.2.155. PMIx_App_free

PMIx_App_free — Release an array of pmix_app_t(5) structures allocated by PMIx_App_create(3).

18.2.155.1. SYNOPSIS

#include <pmix.h>

void PMIx_App_free(pmix_app_t *p, size_t n);

18.2.155.1.1. Python Syntax

No Python equivalent

18.2.155.2. INPUT PARAMETERS

p: Pointer to the array of pmix_app_t(5) structures to be released.
n: Number of structures in the array.

18.2.155.3. DESCRIPTION

Release an array of pmix_app_t structures that was previously allocated by PMIx_App_create(3). Each of the n elements is destructed (its payload — cmd, argv, env, cwd, and info — is released) and then the array storage itself is freed.

If p is NULL or n is zero, the function does nothing.

18.2.155.4. RETURN VALUE

PMIx_App_free returns no value (void).

18.2.155.5. NOTES

PMIx_App_free is the counterpart of PMIx_App_create(3). The n passed here must match the count used at creation. For releasing a single app structure, PMIx_App_release(3) is a convenience wrapper equivalent to PMIx_App_free(p, 1).