pmnameindom(3) — Linux manual page

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

PMNAMEINDOM(3)          Library Functions Manual          PMNAMEINDOM(3)

NAME         top

       pmNameInDom - translate an instance identifier into an instance
       name

C SYNOPSIS         top

       #include <pcp/pmapi.h>

       int pmNameInDom(pmInDom indom, int inst, char **name);

       cc ... -lpcp

DESCRIPTION         top

       For the instance domain indom, in the current Performance Metrics
       Application Programming Interface (PMAPI) context, locate the
       instance with the internal instance identifier given by inst, and
       return the full external instance identification via name.

       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.

       The space for the value of name will have been allocated in
       pmNameInDom with malloc(3), and it is the responsibility of the
       caller to free(3) the space when it is no longer required.

       pmNameInDom returns zero on success.

SEE ALSO         top

       PMAPI(3), pmGetConfig(3), pmGetInDom(3), pmLookupInDom(3),
       pmNameInDomArchive(3), pcp.conf(5) and pcp.env(5).

DIAGNOSTICS         top

       PM_ERR_INDOM
              indom is not a valid instance domain identifier

       PM_ERR_INST
              The instance identifier inst is not known for the instance
              domain indom in the current PMAPI context

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                    PMNAMEINDOM(3)

Pages that refer to this page: pcpintro(3)pmapi(3)pmfetchgroup(3)pmgetindom(3)pmlookupindom(3)pmnameindomarchive(3)pmsetmode(3)pmwebapi(3)