pmindomstr(3) — Linux manual page

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

PMINDOMSTR(3)           Library Functions Manual           PMINDOMSTR(3)

NAME         top

       pmInDomStr, pmInDomStr_r - convert a performance metric instance
       domain identifier into a string

C SYNOPSIS         top

       #include <pcp/pmapi.h>

       const char *pmInDomStr(pmInDom indom);
       char *pmInDomStr_r(pmInDom indom, char *buf, int buflen);

       cc ... -lpcp

DESCRIPTION         top

       For use in error and diagnostic messages, pmInDomStr return a
       'human readable' version of the specified instance domain
       identifier.  The pmInDomStr_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 the instance domain indom is typically extracted
       from a pmDesc structure, following a call to pmLookupDesc(3) for
       a particular performance metric.

       Internally, an instance domain identifier is encoded with two
       fields: domain and serial.

       pmInDomStr returns a string with each of the fields appearing as
       decimal numbers, separated by periods.

       The string value returned by pmInDomStr is held in a single
       static buffer, so the returned value is only valid until the next
       call to pmInDomStr.

NOTES         top

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

PCP ENVIRONMENT         top

       Environment variables with the prefix PCP_ are used to
       parameterize the file and directory names used by PCP.  On each
       installation, the file /etc/pcp.conf contains the local values
       for these variables.  The $PCP_CONF variable may be used to
       specify an alternative configuration file, as described in
       pcp.conf(5).  Values for these variables may be obtained
       programmatically using the pmGetConfig(3) function.

SEE ALSO         top

       PMAPI(3), pmGetConfig(3), pmIDStr(3), pmTypeStr(3), pmSemStr(3),
       pmUnitsStr(3), pmLookupDesc(3), pcp.conf(5) and pcp.env(5).

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 2020-12-18.
       (At that time, the date of the most recent commit that was found
       in the repository was 2020-12-18.)  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                     PMINDOMSTR(3)

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