18.2.47. PMIx_Proc_state_string

PMIx_Proc_state_string — Return the string representation of a pmix_proc_state_t value.

18.2.47.1. SYNOPSIS

#include <pmix.h>

const char* PMIx_Proc_state_string(pmix_proc_state_t state);

18.2.47.2. INPUT PARAMETERS

state : A pmix_proc_state_t process-state value.

Recognized values map to a human-readable string, for example:

PMIX_PROC_STATE_UNDEF — "UNDEFINED"
PMIX_PROC_STATE_RUNNING — "PROC EXECUTING"
PMIX_PROC_STATE_CONNECTED — "PROC HAS CONNECTED TO LOCAL PMIX SERVER"
PMIX_PROC_STATE_TERMINATED — "PROC HAS TERMINATED"
PMIX_PROC_STATE_ABORTED — "PROC ABNORMALLY ABORTED"
PMIX_PROC_STATE_CALLED_ABORT — "PROC CALLED PMIx_Abort"

18.2.47.3. DESCRIPTION

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

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