18.2.54. PMIx_Alloc_inheritance_string

PMIx_Alloc_inheritance_string — Return the string representation of a pmix_alloc_inheritance_t value.

18.2.54.1. SYNOPSIS

#include <pmix.h>

const char* PMIx_Alloc_inheritance_string(pmix_alloc_inheritance_t inheritance);

18.2.54.2. INPUT PARAMETERS

inheritance : A pmix_alloc_inheritance_t allocation-inheritance value.

Recognized values map to a human-readable string:

PMIX_ALLOC_INHERIT_NONE — "NONE"
PMIX_ALLOC_INHERIT_CHILD — "CHILD"
PMIX_ALLOC_INHERIT_DEFAULT — "DEFAULT"
PMIX_ALLOC_INHERIT_CHILD_DEFAULT — "CHILD_DEFAULT"

18.2.54.3. DESCRIPTION

Return a human-readable, statically-allocated string naming the given pmix_alloc_inheritance_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 "UNSPECIFIED".

18.2.54.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.