18.2.128. PMIx_Info_processed

PMIx_Info_processed — Mark a pmix_info_t(5) as processed

18.2.128.1. SYNOPSIS

#include <pmix.h>

void PMIx_Info_processed(pmix_info_t *p);

18.2.128.1.1. Python Syntax

No Python equivalent

18.2.128.2. INPUT PARAMETERS

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

18.2.128.3. DESCRIPTION

The PMIx_Info_processed function sets the PMIX_INFO_REQD_PROCESSED directive bit in the info structure’s flags field. This bit records that a required directive carried by the info has already been acted upon, allowing code that handles required attributes to note which ones have been satisfied and avoid processing them a second time.

Whether an info has been marked processed can be tested with PMIx_Info_was_processed(3).

18.2.128.4. RETURN VALUE

PMIx_Info_processed returns no value (void).

18.2.128.5. NOTES

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

This flag is closely associated with the required/optional directives; see PMIx_Info_required(3).