18.2.49. PMIx_Persistence_string

PMIx_Persistence_string — Return the string representation of a pmix_persistence_t value.

18.2.49.1. SYNOPSIS

#include <pmix.h>

const char* PMIx_Persistence_string(pmix_persistence_t persist);

18.2.49.2. INPUT PARAMETERS

persist : A pmix_persistence_t data-persistence value.

Recognized values map to a human-readable string:

PMIX_PERSIST_INDEF — "INDEFINITE"
PMIX_PERSIST_FIRST_READ — "DELETE ON FIRST ACCESS"
PMIX_PERSIST_PROC — "RETAIN UNTIL PUBLISHING PROCESS TERMINATES"
PMIX_PERSIST_APP — "RETAIN UNTIL APPLICATION OF PUBLISHING PROCESS TERMINATES"
PMIX_PERSIST_SESSION — "RETAIN UNTIL ALLOCATION OF PUBLISHING PROCESS TERMINATES"
PMIX_PERSIST_INVALID — "INVALID"

18.2.49.3. DESCRIPTION

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

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