18.2.52. PMIx_Alloc_directive_string

PMIx_Alloc_directive_string — Return the string representation of a pmix_alloc_directive_t value.

18.2.52.1. SYNOPSIS

#include <pmix.h>

const char* PMIx_Alloc_directive_string(pmix_alloc_directive_t directive);

18.2.52.2. INPUT PARAMETERS

  • directive : A pmix_alloc_directive_t allocation directive.

Recognized values map to a human-readable string:

  • PMIX_ALLOC_NEW"NEW"

  • PMIX_ALLOC_EXTEND"EXTEND"

  • PMIX_ALLOC_RELEASE"RELEASE"

  • PMIX_ALLOC_REAQUIRE"REACQUIRE"

18.2.52.3. DESCRIPTION

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