18.2.119. PMIx_Info_set_end

PMIx_Info_set_end — Mark a pmix_info_t(5) as the end of an array.

18.2.119.1. SYNOPSIS

#include <pmix.h>

void PMIx_Info_set_end(pmix_info_t *p);

18.2.119.1.1. Python Syntax

No Python equivalent

18.2.119.2. INPUT PARAMETERS

p: Pointer to the pmix_info_t(5) structure to mark.

18.2.119.3. DESCRIPTION

Set the PMIX_INFO_ARRAY_END flag in the flags field of the referenced pmix_info_t structure. This marks the structure as the final element of an array of pmix_info_t structures, allowing the array to be traversed without a separately maintained count.

The marker is subsequently tested with PMIx_Info_is_end(3).

18.2.119.4. RETURN VALUE

PMIx_Info_set_end returns no value (void).