.. _man3-PMIx_Info_required: PMIx_Info_required ================== .. include_body ``PMIx_Info_required`` |mdash| Mark a :ref:`pmix_info_t(5) ` as required SYNOPSIS -------- .. code-block:: c #include void PMIx_Info_required(pmix_info_t *p); Python Syntax ^^^^^^^^^^^^^ No Python equivalent INPUT PARAMETERS ---------------- * ``p``: Pointer to the :ref:`pmix_info_t(5) ` structure to be marked required. 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 :ref:`PMIx_Info_optional(3) `, which clears the same bit. Whether an info is currently marked required can be tested with :ref:`PMIx_Info_is_required(3) `. 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. .. seealso:: :ref:`PMIx_Info_optional(3) `, :ref:`PMIx_Info_is_required(3) `, :ref:`PMIx_Info_is_optional(3) `, :ref:`pmix_info_t(5) `