Scroll to navigation

PMIX_LOAD_KEY(3) OpenPMIx PMIX_LOAD_KEY(3)

PMIx_Load_key — Load a string into a pmix_key_t(5) <#man5-pmix-key-t>

SYNOPSIS

#include <pmix.h>
void PMIx_Load_key(pmix_key_t key, const char *src);


Python Syntax

No Python equivalent

INPUT PARAMETERS

  • key: The pmix_key_t(5) <#man5-pmix-key-t> (a fixed-size character array) into which the string is to be loaded. The storage must already exist — it is supplied by the caller.
  • src: Pointer to a NULL-terminated string to be copied into key. May be NULL.

DESCRIPTION

Load the contents of a NULL-terminated string into a pmix_key_t <#man5-pmix-key-t>. The function first zeroes the entire key array (all PMIX_MAX_KEYLEN + 1 bytes) and then, if src is non-NULL, copies up to PMIX_MAX_KEYLEN characters from src into it. A string longer than PMIX_MAX_KEYLEN is silently truncated; the result is always properly NULL-terminated because the trailing byte is left as the zero written during the initial clear. If src is NULL the key is simply left cleared (all zeroes).

RETURN VALUE

PMIx_Load_key returns no value (void).

NOTES

PMIx_Load_key is an OpenPMIx convenience routine and is the backing implementation of the PMIX_LOAD_KEY macro.

See also:

PMIx_Check_key(3) <#man3-pmix-check-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