18.2.118. PMIx_Info_is_required

PMIx_Info_is_required — Test whether a pmix_info_t(5) is marked as required.

18.2.118.1. SYNOPSIS

#include <pmix.h>

bool PMIx_Info_is_required(const pmix_info_t *p);

18.2.118.1.1. Python Syntax

No Python equivalent

18.2.118.2. INPUT PARAMETERS

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

18.2.118.3. DESCRIPTION

Test whether the PMIX_INFO_REQD flag is set in the flags field of the referenced pmix_info_t structure. A required directive is one that the receiving process is obligated to honor; if it cannot be satisfied, the associated operation is expected to fail rather than proceed while ignoring the directive.

The required flag is applied with PMIx_Info_required(3) and cleared with PMIx_Info_optional(3).

18.2.118.4. RETURN VALUE

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