18.2.230. PMIx_Load_key

PMIx_Load_key — Load a string into a pmix_key_t(5)

18.2.230.1. SYNOPSIS

#include <pmix.h>

void PMIx_Load_key(pmix_key_t key, const char *src);

18.2.230.1.1. Python Syntax

No Python equivalent

18.2.230.2. INPUT PARAMETERS

key: The pmix_key_t(5) (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.

18.2.230.3. DESCRIPTION

Load the contents of a NULL-terminated string into a 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).

18.2.230.4. RETURN VALUE

PMIx_Load_key returns no value (void).

18.2.230.5. NOTES

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