pmErrStr man page

pmErrStr, pmErrStr_r — convert a PMAPI error code into a string

C Synopsis

#include <pcp/pmapi.h>

const char *pmErrStr(int code);
char *pmErrStr_r(int code, char *buf, int buflen);

cc ... -lpcp


Translate an error code into a text string, suitable for generating a diagnostic message. The pmErrStr_r function does the same, but stores the result in a user-supplied buffer buf of length buflen, which should have room for at least PM_MAXERRMSGLEN bytes.

By convention, all error codes are negative. The small values are assumed to be negated versions of the Unix error codes as defined in <errno.h> and the strings returned are as per strerror(3). The larger, negative error codes are Performance Metrics Application Programming Interface (PMAPI) error conditions and pmErrStr(3) returns an appropriate PMAPI error string, as determined by code.


pmErrStr returns a pointer to a static buffer, so the returned value is only valid until the next call to pmErrStr and hence is not thread-safe. Multi-threaded applications should use pmErrStr_r instead.

See Also

pmerr(1), PMAPI(3) and perror(3).

Referenced By

PCPIntro(3), __pmAFblock(3), PMAPI(3), pmdaCacheLookup(3), pmdaCloseHelp(3), pmdaEventNewActiveQueue(3), pmdaRootConnect(3), pmerr(1), pmFetch(3), pmflush(3), pmiErrStr(3), pmjsonGet(3), pmLoadDerivedConfig(3), pmns(5), pmprobe(1), pmRecordAddHost(3), pmUnpackEventRecords(3).

PCP Performance Co-Pilot