18.2.141. PMIx_Data_array_init

PMIx_Data_array_init — Initialize the fields of a caller-provided pmix_data_array_t(5) structure.

18.2.141.1. SYNOPSIS

#include <pmix.h>

void PMIx_Data_array_init(pmix_data_array_t *p, pmix_data_type_t type);

18.2.141.1.1. Python Syntax

No Python equivalent

18.2.141.2. INPUT PARAMETERS

p: Pointer to the pmix_data_array_t(5) structure to be initialized. The storage for the structure itself must already exist — it is supplied by the caller.
type: The pmix_data_type_t(5) that the array will hold.

18.2.141.3. DESCRIPTION

Initialize the fields of a pmix_data_array_t without allocating any element storage. The array pointer is set to NULL, the type field is set to the supplied type, and the size field is set to zero.

Unlike PMIx_Data_array_construct(3), PMIx_Data_array_init does not allocate a backing element array; it only records the intended element type and leaves the array empty. It is useful when the element storage will be assigned separately.

18.2.141.4. RETURN VALUE

PMIx_Data_array_init returns no value (void).

18.2.141.5. NOTES

To also allocate the backing element array, use PMIx_Data_array_construct(3) instead. If element storage is later attached to the array field, release it with PMIx_Data_array_destruct(3).