NAME | C SYNOPSIS | DESCRIPTION | NOTES | SEE ALSO | COLOPHON

PMSEMSTR(3)               Library Functions Manual               PMSEMSTR(3)

NAME         top

       pmSemStr,  pmSemStr_r  - convert a performance metric semantic into a
       string

C SYNOPSIS         top

       #include <pcp/pmapi.h>

       const char *pmSemStr(int sem);
       char *pmSemStr_r(int sem, char *buf, int buflen);

       cc ... -lpcp

DESCRIPTION         top

       Given a performance metric semantic, pmSemStr produces a terse ASCII
       equivalent, appropriate for use in error and diagnostic messages.
       The pmSemStr_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 sem is typically extracted from a pmDesc structure,
       following a call to pmLookupDesc(3) for a particular performance
       metric.

       Examples are counter (for sem equals PM_SEM_COUNTER), discrete (for
       sem equals PM_SEM_DISCRETE), instant (for sem equals PM_SEM_INSTANT),
       etc.

NOTES         top

       Both of these routines are safe to call from threaded applications.

SEE ALSO         top

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

COLOPHON         top

       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@groups.io.  This page was obtained from the project's upstream
       Git repository ⟨https://github.com/performancecopilot/pcp.git⟩ on
       2019-07-28.  (At that time, the date of the most recent commit that
       was found in the repository was 2019-07-26.)  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                         PMSEMSTR(3)

Pages that refer to this page: pmidstr(3)pmindomstr(3)pmtypestr(3)pmunitsstr(3)pmwebapi(3)