Scroll to navigation

PMIX_APP_FREE(3) OpenPMIx PMIX_APP_FREE(3)

PMIx_App_free — Release an array of pmix_app_t(5) <#man5-pmix-app-t> structures allocated by PMIx_App_create(3) <#man3-pmix-app-create>.

SYNOPSIS

#include <pmix.h>
void PMIx_App_free(pmix_app_t *p, size_t n);


Python Syntax

No Python equivalent

INPUT PARAMETERS

  • p: Pointer to the array of pmix_app_t(5) <#man5-pmix-app-t> structures to be released.
  • n: Number of structures in the array.

DESCRIPTION

Release an array of pmix_app_t <#man5-pmix-app-t> structures that was previously allocated by PMIx_App_create(3) <#man3-pmix-app-create>. 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.

RETURN VALUE

PMIx_App_free returns no value (void).

NOTES

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

See also:

PMIx_App_construct(3) <#man3-pmix-app-construct>, PMIx_App_destruct(3) <#man3-pmix-app-destruct>, PMIx_App_create(3) <#man3-pmix-app-create>, PMIx_App_info_create(3) <#man3-pmix-app-info-create>, PMIx_App_release(3) <#man3-pmix-app-release>, pmix_app_t(5) <#man5-pmix-app-t>


Copyright

2014-2026, OpenPMIx Community

September 27, 2026