18.2.130. PMIx_Info_required

PMIx_Info_required — Mark a pmix_info_t(5) as required

18.2.130.1. SYNOPSIS

#include <pmix.h>

void PMIx_Info_required(pmix_info_t *p);

18.2.130.1.1. Python Syntax

No Python equivalent

18.2.130.2. INPUT PARAMETERS

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

18.2.130.3. DESCRIPTION

The PMIx_Info_required function sets the PMIX_INFO_REQD directive bit in the info structure’s flags field. Marking an info required tells the PMIx implementation (and the host environment) that the directive it carries must be honored: a request that cannot satisfy a required directive should fail rather than silently ignore it.

This is the inverse of PMIx_Info_optional(3), which clears the same bit. Whether an info is currently marked required can be tested with PMIx_Info_is_required(3).

18.2.130.4. RETURN VALUE

PMIx_Info_required returns no value (void).

18.2.130.5. NOTES

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