Scroll to navigation

PMIX_INFO_FREE(3) OpenPMIx PMIX_INFO_FREE(3)

PMIx_Info_free — Release an array of pmix_info_t(5) <#man5-pmix-info-t> structures

SYNOPSIS

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


Python Syntax

No Python equivalent

INPUT PARAMETERS

  • p: Pointer to the array of pmix_info_t(5) <#man5-pmix-info-t> structures to be released. This must be storage that was allocated by the library (e.g., via PMIx_Info_create(3) <#man3-pmix-info-create>).
  • n: Number of structures in the array.

DESCRIPTION

The PMIx_Info_free function releases the contents of each element in an array of pmix_info_t(5) <#man5-pmix-info-t> structures and then frees the array storage itself. Each element is destructed exactly as by PMIx_Info_destruct(3) <#man3-pmix-info-destruct> — the contained pmix_value_t(5) <#man5-pmix-value-t> payload is released unless the element has been marked persistent — after which the block of memory holding the array is returned to the system.

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

PMIx_Info_free is the counterpart to PMIx_Info_create(3) <#man3-pmix-info-create>. Use it only on library-allocated array storage; to release the contents of a single caller-owned (stack or embedded) structure without freeing it, use PMIx_Info_destruct(3) <#man3-pmix-info-destruct> instead.

RETURN VALUE

PMIx_Info_free returns no value (void).

NOTES

PMIx_Info_free is the OpenPMIx routine underlying the historical PMIX_INFO_FREE macro. That macro is retained in pmix_deprecated.h for backward compatibility; it calls this function and then sets the caller’s pointer to NULL.

EXAMPLES

Allocate and later release an array:

pmix_info_t *info;
info = PMIx_Info_create(3);
/* ... populate and use the array ... */
PMIx_Info_free(info, 3);


See also:

PMIx_Info_create(3) <#man3-pmix-info-create>, PMIx_Info_construct(3) <#man3-pmix-info-construct>, PMIx_Info_destruct(3) <#man3-pmix-info-destruct>, PMIx_Info_persistent(3) <#man3-pmix-info-persistent>, pmix_info_t(5) <#man5-pmix-info-t>, pmix_value_t(5) <#man5-pmix-value-t>


Copyright

2014-2026, OpenPMIx Community

September 27, 2026