Scroll to navigation

PMIX_CHECK_KEY(3) OpenPMIx PMIX_CHECK_KEY(3)

PMIx_Check_key — Compare a pmix_key_t(5) <#man5-pmix-key-t> against a string for equality

SYNOPSIS

#include <pmix.h>
bool PMIx_Check_key(const char *key, const char *str);


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.
  • str: Pointer to the string to compare against.

DESCRIPTION

Compare a key against a given string for equality. The comparison examines at most PMIX_MAX_KEYLEN characters, which is the maximum length a pmix_key_t <#man5-pmix-key-t> can hold. This provides a safe, bounded way to test whether a key matches an expected attribute string without risking a read past the end of the fixed-size key array.

RETURN VALUE

Returns true if the first PMIX_MAX_KEYLEN characters of key and str match, and false otherwise.

NOTES

PMIx_Check_key is an OpenPMIx convenience routine and is the backing implementation of the PMIX_CHECK_KEY macro. Both arguments must point to valid, NULL-terminated strings; the routine performs no NULL checking.

See also:

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


Copyright

2014-2026, OpenPMIx Community

September 27, 2026