18.2.114. PMIx_Info_is_end

PMIx_Info_is_end — Test whether a pmix_info_t(5) marks the end of an array.

18.2.114.1. SYNOPSIS

#include <pmix.h>

bool PMIx_Info_is_end(const pmix_info_t *p);

18.2.114.1.1. Python Syntax

No Python equivalent

18.2.114.2. INPUT PARAMETERS

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

18.2.114.3. DESCRIPTION

Test whether the PMIX_INFO_ARRAY_END flag is set in the flags field of the referenced pmix_info_t structure. This flag is used to mark the final element of an array of pmix_info_t structures, allowing the array to be traversed without a separately maintained count.

The end marker is applied with PMIx_Info_set_end(3).

18.2.114.4. RETURN VALUE

Returns true if the PMIX_INFO_ARRAY_END flag is set in the structure, and false otherwise.