18.2.115. PMIx_Info_is_optional

PMIx_Info_is_optional — Test whether a pmix_info_t(5) is marked as optional.

18.2.115.1. SYNOPSIS

#include <pmix.h>

bool PMIx_Info_is_optional(const pmix_info_t *p);

18.2.115.1.1. Python Syntax

No Python equivalent

18.2.115.2. INPUT PARAMETERS

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

18.2.115.3. DESCRIPTION

Test whether the referenced pmix_info_t structure is optional. An optional directive is one the receiving process may honor if it is able, but is not obligated to satisfy; the associated operation is expected to proceed even when the directive cannot be met.

Optional is the complement of required: this routine returns true precisely when the PMIX_INFO_REQD flag is not set in the flags field. It is therefore the logical negation of PMIx_Info_is_required(3). The optional state is applied with PMIx_Info_optional(3).

18.2.115.4. RETURN VALUE

Returns true if the PMIX_INFO_REQD flag is not set in the structure, and false if it is set.