SYNOPSIS¶

#include <pmix.h>
const char* PMIx_Error_string(pmix_status_t status);

from pmix import *
foo = PMIxClient()
# status is an integer PMIx status code
string = foo.error_string(PMIX_ERR_NOT_FOUND)

INPUT PARAMETERS¶

DESCRIPTION¶

Return a human-readable, NULL-terminated string that names the provided PMIx status code. The function searches the library’s table of known status and event constants for one whose numeric value matches status and returns its symbolic name (for example, "NOT-FOUND" for PMIX_ERR_NOT_FOUND).

PMIx_Error_string may be called at any time, including outside of the initialized region, and is usable by servers and tools in addition to clients.

Note:

RETURN VALUE¶

Returns a pointer to a statically allocated, NULL-terminated string naming the provided status code. If status does not correspond to any status or event constant known to the library, the fixed string "ERROR STRING NOT FOUND" is returned. The function always returns a valid, non-NULL pointer.

NOTES¶

PMIx_Error_string is the inverse of PMIx_Error_code(3) <#man3-pmix-error-code>, which maps a status name string back to its numeric pmix_status_t value.

A deprecation rename leaves two names sharing one value — for example PMIX_ERR_EXISTS and the deprecated PMIX_EXISTS. In that case PMIx_Error_string returns the current name, not the deprecated alias.

Because the returned string is owned by the library, callers must never pass it to free().

See also:

Copyright¶

2014-2026, OpenPMIx Community