18.2.231. PMIx_Load_nspace

PMIx_Load_nspace — Load a string into a pmix_nspace_t(5)

18.2.231.1. SYNOPSIS

#include <pmix.h>

void PMIx_Load_nspace(pmix_nspace_t nspace, const char *str);

18.2.231.1.1. Python Syntax

No Python equivalent

18.2.231.2. INPUT PARAMETERS

nspace: The pmix_nspace_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.
str: Pointer to a NULL-terminated string to be copied into nspace. May be NULL.

18.2.231.3. DESCRIPTION

Load the contents of a NULL-terminated string into a pmix_nspace_t. The function first zeroes the entire namespace array (all PMIX_MAX_NSLEN + 1 bytes) and then, if str is non-NULL, copies up to PMIX_MAX_NSLEN characters from str into it. A string longer than PMIX_MAX_NSLEN is silently truncated; the result is always properly NULL-terminated. If str is NULL the namespace is simply left cleared (all zeroes), which is the invalid/empty namespace value.

18.2.231.4. RETURN VALUE

PMIx_Load_nspace returns no value (void).

18.2.231.5. NOTES

PMIx_Load_nspace is an OpenPMIx convenience routine and is the backing implementation of the PMIX_LOAD_NSPACE macro.