18.2.50. PMIx_Data_range_string

PMIx_Data_range_string — Return the string representation of a pmix_data_range_t value.

18.2.50.1. SYNOPSIS

#include <pmix.h>

const char* PMIx_Data_range_string(pmix_data_range_t range);

18.2.50.2. INPUT PARAMETERS

range : A pmix_data_range_t data-range value.

Recognized values map to a human-readable string:

PMIX_RANGE_UNDEF — "UNDEFINED"
PMIX_RANGE_RM — "INTENDED FOR HOST RESOURCE MANAGER ONLY"
PMIX_RANGE_LOCAL — "AVAIL ON LOCAL NODE ONLY"
PMIX_RANGE_NAMESPACE — "AVAIL TO PROCESSES IN SAME JOB ONLY"
PMIX_RANGE_SESSION — "AVAIL TO PROCESSES IN SAME ALLOCATION ONLY"
PMIX_RANGE_GLOBAL — "AVAIL TO ANYONE WITH AUTHORIZATION"
PMIX_RANGE_CUSTOM — "AVAIL AS SPECIFIED IN DIRECTIVES"
PMIX_RANGE_PROC_LOCAL — "AVAIL ON LOCAL PROC ONLY"
PMIX_RANGE_INVALID — "INVALID"

18.2.50.3. DESCRIPTION

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

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