18.2.62. PMIx_Group_operation_string

PMIx_Group_operation_string — Return the string representation of a pmix_group_operation_t value.

18.2.62.1. SYNOPSIS

#include <pmix.h>

const char* PMIx_Group_operation_string(pmix_group_operation_t op);

18.2.62.2. INPUT PARAMETERS

op: A group operation value of type pmix_group_operation_t. Recognized values are PMIX_GROUP_NONE, PMIX_GROUP_CONSTRUCT, PMIX_GROUP_DESTRUCT, and PMIX_GROUP_CANCEL.

18.2.62.3. DESCRIPTION

Return a human-readable, statically-allocated string describing the given group operation. The recognized operations map to "CONSTRUCT", "DESTRUCT", "NONE", and "CANCEL". If the value does not correspond to a recognized group operation, the fallback string "UNKNOWN VALUE" is returned.

The returned pointer refers to constant storage owned by the PMIx library. The caller must not modify or free it.

18.2.62.4. RETURN VALUE

Returns a pointer to a constant, statically-allocated character string. The pointer is always non-NULL and must not be freed by the caller.