Scroll to navigation

PMIX_CHECK_RESERVED_KEY(3) OpenPMIx PMIX_CHECK_RESERVED_KEY(3)

PMIx_Check_reserved_key — Test whether a pmix_key_t(5) <#man5-pmix-key-t> lies in the PMIx-reserved namespace

SYNOPSIS

#include <pmix.h>
bool PMIx_Check_reserved_key(const char *key);


Python Syntax

No Python equivalent

INPUT PARAMETERS

•
key: Pointer to the key (typically a pmix_key_t(5) <#man5-pmix-key-t>) to be tested.

DESCRIPTION

Determine whether a key belongs to the reserved key space defined by the PMIx Standard. All attribute keys defined by PMIx itself begin with the "pmix" prefix; user code is prohibited from using that prefix so as to avoid collisions with library-defined attributes. This routine tests for that reserved prefix by comparing the first four characters of key against the string "pmix".

RETURN VALUE

Returns true if key begins with the reserved "pmix" prefix, indicating a PMIx-reserved key, and false otherwise.

NOTES

PMIx_Check_reserved_key is an OpenPMIx convenience routine and is the backing implementation of the PMIX_CHECK_RESERVED_KEY macro. The argument must point to a valid string of at least four characters; the routine performs no NULL checking.

See also:

PMIx_Check_key(3) <#man3-pmix-check-key>, PMIx_Load_key(3) <#man3-pmix-load-key>, pmix_key_t(5) <#man5-pmix-key-t>


Copyright

2014-2026, OpenPMIx Community

September 27, 2026