|
NAME | C SYNOPSIS | DESCRIPTION | NOTES | SEE ALSO | COLOPHON |
PMTYPESTR(3) Library Functions Manual PMTYPESTR(3)
pmTypeStr, pmTypeStr_r - convert a performance metric type into a
string
#include <pcp/pmapi.h>
const char *pmTypeStr(int type);
char *pmTypeStr_r(int type, char *buf, int buflen);
cc ... -lpcp
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
pmTypeStr.
pmTypeStr returns a pointer to a static buffer and hence is not
thread-safe. Multi-threaded applications should use pmTypeStr_r
instead.
PMAPI(3), pmAtomStr(3), pmConvScale(3), pmExtractValue(3),
pmLookupDesc(3), pmPrintValue(3), pmIDStr(3), pmInDomStr(3),
pmSemStr(3) and pmUnitsStr(3).
This page is part of the PCP (Performance Co-Pilot) project.
Information about the project can be found at ⟨http://www.pcp.io/⟩.
If you have a bug report for this manual page, send it to
pcp@oss.sgi.com. This page was obtained from the project's upstream
Git repository ⟨git://git.pcp.io/pcp⟩ on 2017-07-05. If you discover
any rendering problems in this HTML version of the page, or you
believe there is a better or more up-to-date source for the page, or
you have corrections or improvements to the information in this
COLOPHON (which is not part of the original manual page), send a mail
to man-pages@man7.org
Performance Co-Pilot PCP PMTYPESTR(3)
Pages that refer to this page: pmatomstr(3), pmconvscale(3), pmextractvalue(3), pmidstr(3), pmindomstr(3), pmlookupdesc(3), pmprintvalue(3), pmsemstr(3), pmunitsstr(3)