18.2.126. PMIx_Info_optional

PMIx_Info_optional — Mark a pmix_info_t(5) as optional

18.2.126.1. SYNOPSIS

#include <pmix.h>

void PMIx_Info_optional(pmix_info_t *p);

18.2.126.1.1. Python Syntax

No Python equivalent

18.2.126.2. INPUT PARAMETERS

p: Pointer to the pmix_info_t(5) structure to be marked optional.

18.2.126.3. DESCRIPTION

The PMIx_Info_optional function clears the PMIX_INFO_REQD directive bit in the info structure’s flags field. Marking an info optional tells the PMIx implementation (and the host environment) that the directive it carries is advisory: a request may proceed and succeed even if the directive cannot be honored.

This is the inverse of PMIx_Info_required(3), which sets the same bit. Because an info’s flags default to zero at construction, a freshly constructed info is already optional; this function is used to return a previously-required info to the optional state. Whether an info is currently optional can be tested with PMIx_Info_is_optional(3).

18.2.126.4. RETURN VALUE

PMIx_Info_optional returns no value (void).

18.2.126.5. NOTES

PMIx_Info_optional is the OpenPMIx routine underlying the historical PMIX_INFO_OPTIONAL macro. That macro is retained in pmix_deprecated.h for backward compatibility and simply expands to a call to this function.