pmnameindomarchive(3) — Linux manual page

PMNAMEINDOMARCHIVE(3)   Library Functions Manual   PMNAMEINDOMARCHIVE(3)

NAME

       pmNameInDomArchive - translate an instance identifier into an
       instance name

C SYNOPSIS

       #include <pcp/pmapi.h>

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

       cc ... -lpcp

DESCRIPTION

       Provided that the current Performance Metrics Application
       Programming Interface (PMAPI) context is associated with a set of
       archives, pmNameInDomArchive will scan the union of all the
       instance domain metadata for the instance domain indom, locate
       the first instance with the internal instance identifier given by
       inst, and return the full external instance identification via
       name.

       This routine is a specialized version of the more general PMAPI
       routine pmNameInDom.

       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
       pmNameInDomArchive with malloc(3), and it is the responsibility
       of the caller to free(3) the space when it is no longer required.

       pmNameInDomArchive returns zero on success.

DIAGNOSTICS

       PM_ERR_NOTARCHIVE
              the current PMAPI context is not associated with a set of
              archives

       PM_ERR_INDOM_LOG
              indom is not a defined instance domain identifier for the
              set of archives

       PM_ERR_INST_LOG
              the instance identifier inst is not known for the instance
              domain indom in the set of archives

SEE ALSO

       PMAPI(3), pmGetConfig(3), pmGetInDomArchive(3),
       pmLookupInDomArchive(3), pmNameInDom(3), pcp.conf(5) and
       pcp.env(5).

COLOPHON

       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 2024-06-14.
       (At that time, the date of the most recent commit that was found
       in the repository was 2024-06-14.)  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             PMNAMEINDOMARCHIVE(3)

Pages that refer to this page: pcpintro(3), pmgetindomarchive(3), pmlookupindomarchive(3), pmnameindom(3)

---