18.2.233. PMIx_Check_reserved_key

PMIx_Check_reserved_key — Test whether a pmix_key_t(5) lies in the PMIx-reserved namespace

18.2.233.1. SYNOPSIS

#include <pmix.h>

bool PMIx_Check_reserved_key(const char *key);

18.2.233.1.1. Python Syntax

No Python equivalent

18.2.233.2. INPUT PARAMETERS

key: Pointer to the key (typically a pmix_key_t(5)) to be tested.

18.2.233.3. 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".

18.2.233.4. RETURN VALUE

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

18.2.233.5. 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.