Scroll to navigation

PMIX_REGATTR_CONSTRUCT(3) OpenPMIx PMIX_REGATTR_CONSTRUCT(3)

PMIx_Regattr_construct — Initialize a caller-provided pmix_regattr_t(5) <#man5-pmix-regattr-t> structure.

SYNOPSIS

#include <pmix.h>
void PMIx_Regattr_construct(pmix_regattr_t *p);


Python Syntax

No Python equivalent

INPUT PARAMETERS

•
p: Pointer to the pmix_regattr_t(5) <#man5-pmix-regattr-t> structure to be initialized. The storage for the structure itself must already exist — it is supplied by the caller (typically declared on the stack or embedded within another object).

DESCRIPTION

Initialize the memory of a pmix_regattr_t <#man5-pmix-regattr-t> that the caller has already allocated. The function sets the name pointer to NULL, clears the string key field, sets type to PMIX_UNDEF, and sets the description pointer to NULL. No heap memory is allocated.

Because PMIx_Regattr_construct operates on caller-provided storage, it must be paired with PMIx_Regattr_destruct(3) <#man3-pmix-regattr-destruct> to release any name or description the structure subsequently acquires (for example via PMIx_Regattr_load(3) <#man3-pmix-regattr-load>).

RETURN VALUE

PMIx_Regattr_construct returns no value (void).

NOTES

The PMIX_REGATTR_CONSTRUCT convenience macro is a direct wrapper for this function.

EXAMPLES

Construct a structure:

pmix_regattr_t attr;
PMIx_Regattr_construct(&attr);


See also:

PMIx_Regattr_destruct(3) <#man3-pmix-regattr-destruct>, PMIx_Regattr_create(3) <#man3-pmix-regattr-create>, PMIx_Regattr_free(3) <#man3-pmix-regattr-free>, PMIx_Regattr_load(3) <#man3-pmix-regattr-load>, PMIx_Regattr_xfer(3) <#man3-pmix-regattr-xfer>, pmix_regattr_t(5) <#man5-pmix-regattr-t>


Copyright

2014-2026, OpenPMIx Community

September 27, 2026