SYNOPSIS¶

#include <pmix.h>
void PMIx_Info_required(pmix_info_t *p);

INPUT PARAMETERS¶

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) <#man3-pmix-info-optional>, which clears the same bit. Whether an info is currently marked required can be tested with PMIx_Info_is_required(3) <#man3-pmix-info-is-required>.

RETURN VALUE¶

PMIx_Info_required returns no value (void).

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.

See also:

Copyright¶

2014-2026, OpenPMIx Community