18.2.48. PMIx_Scope_string

PMIx_Scope_string — Return the string representation of a pmix_scope_t value.

18.2.48.1. SYNOPSIS

#include <pmix.h>

const char* PMIx_Scope_string(pmix_scope_t scope);

18.2.48.2. INPUT PARAMETERS

scope : A pmix_scope_t data-sharing scope value.

Recognized values map to a human-readable string:

PMIX_SCOPE_UNDEF — "UNDEFINED"
PMIX_LOCAL — "SHARE ON LOCAL NODE ONLY"
PMIX_REMOTE — "SHARE ON REMOTE NODES ONLY"
PMIX_GLOBAL — "SHARE ACROSS ALL NODES"
PMIX_INTERNAL — "STORE INTERNALLY"

18.2.48.3. DESCRIPTION

Return a human-readable, statically-allocated string naming the given pmix_scope_t value. The returned string is owned by the library and must not be modified or freed by the caller. An unrecognized value yields the fallback string "UNKNOWN SCOPE".

18.2.48.4. RETURN VALUE

Returns a pointer to a constant, statically-allocated, NUL-terminated string. The pointer remains valid for the lifetime of the process and must not be freed.