pmerrstr(3) [centos man page]

PMERRSTR(3)						     Library Functions Manual						       PMERRSTR(3)

NAME

       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

DESCRIPTION

       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(3C).  The larger, negative error codes are Performance Metrics Application Program-
       ming Interface (PMAPI) error conditions and pmErrStr(3) returns an appropriate PMAPI error string, as determined by code.

NOTES

       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(3C).

Performance Co-Pilot							PCP							       PMERRSTR(3)

PMTYPESTR(3)						     Library Functions Manual						      PMTYPESTR(3)

NAME

       pmTypeStr, pmTypeStr_r - convert a performance metric type into a string

C SYNOPSIS

       #include <pcp/pmapi.h>

       const char *pmTypeStr(int type);
       char *pmTypeStr_r(int type, char *buf, int buflen);

       cc ... -lpcp

DESCRIPTION

       Given  a  performance  metric type, pmTypeStr produces a terse ASCII equivalent, appropriate for use in error and diagnostic messages.  The
       pmTypeStr_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 20 bytes.

       The value for type is typically extracted from a pmDesc structure, following a call to pmLookupDesc(3) for a particular performance metric.

       Examples are 32 (for type equals PM_TYPE_32), U64 (for type equals PM_TYPE_U64), AGGREGATE (for type equals PM_TYPE_AGGREGATE), etc.

       The string value result for pmTypeStr is held in a single static buffer, so the returned value is only valid until the next call to pmType-
       Str.

NOTES

       pmTypeStr returns a pointer to a static buffer and hence is not thread-safe.  Multi-threaded applications should use pmTypeStr_r instead.

SEE ALSO

       PMAPI(3), pmAtomStr(3), pmConvScale(3), pmExtractValue(3), pmLookupDesc(3), pmPrintValue(3) and pmUnitsStr(3).

Performance Co-Pilot							PCP							      PMTYPESTR(3)