18.2.168. PMIx_Regattr_construct

PMIx_Regattr_construct — Initialize a caller-provided pmix_regattr_t(5) structure.

18.2.168.1. SYNOPSIS

#include <pmix.h>

void PMIx_Regattr_construct(pmix_regattr_t *p);

18.2.168.1.1. Python Syntax

No Python equivalent

18.2.168.2. INPUT PARAMETERS

p: Pointer to the pmix_regattr_t(5) 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).

18.2.168.3. DESCRIPTION

Initialize the memory of a 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) to release any name or description the structure subsequently acquires (for example via PMIx_Regattr_load(3)).

18.2.168.4. RETURN VALUE

PMIx_Regattr_construct returns no value (void).

18.2.168.5. NOTES

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

18.2.168.6. EXAMPLES

Construct a structure:

pmix_regattr_t attr;

PMIx_Regattr_construct(&attr);