18.2.179. PMIx_Coord_construct

PMIx_Coord_construct — Initialize a caller-provided pmix_coord_t(5) structure.

18.2.179.1. SYNOPSIS

#include <pmix.h>

void PMIx_Coord_construct(pmix_coord_t *m);

18.2.179.1.1. Python Syntax

No Python equivalent

18.2.179.2. INPUT PARAMETERS

m: Pointer to the pmix_coord_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.179.3. DESCRIPTION

Initialize the fields of a pmix_coord_t that the caller has already allocated. The function sets the view field to PMIX_COORD_VIEW_UNDEF, the coord pointer to NULL, and the dims field to zero. No heap memory is allocated and no coordinate array is attached.

18.2.179.4. RETURN VALUE

PMIx_Coord_construct returns no value (void).

18.2.179.5. NOTES

Because PMIx_Coord_construct operates on caller-provided storage, it must be paired with PMIx_Coord_destruct(3) to release any coordinate array the structure subsequently acquires. Do not pass a constructed (as opposed to created) structure to PMIx_Coord_free(3), as that would attempt to free storage the library did not allocate.

The convenience macro PMIX_COORD_CONSTRUCT is provided as a direct wrapper around this function.

18.2.179.6. EXAMPLES

Construct a structure:

pmix_coord_t coord;

PMIx_Coord_construct(&coord);