pmlookupindomarchive(3) — Linux manual page

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

PMLOOKUPINDOMARCHIVE(3)  Library Functions Manual PMLOOKUPINDOMARCHIVE(3)

NAME         top

       pmLookupInDomArchive - translate an instance name into an instance
       identifier

C SYNOPSIS         top

       #include <pcp/pmapi.h>

       int pmLookupInDomArchive(pmInDom indom, const char *name);

       cc ... -lpcp

DESCRIPTION         top

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

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

       Only the leading non-space characters of name will be used to
       identify the instance.

       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.

       pmLookupInDomArchive will return a positive instance identifier on
       success.

DIAGNOSTICS         top

       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 external instance name is not known for the instance
              ___domain indom in the set of archives

SEE ALSO         top

       PMAPI(3), pmGetConfig(3), pmGetInDomArchive(3), pmLookupDesc(3),
       pmLookupInDom(3), pmNameInDomArchive(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 [email protected].  This page was obtained from the
       project's upstream Git repository
       ⟨https://github.com/performancecopilot/pcp.git⟩ on 2025-02-02.
       (At that time, the date of the most recent commit that was found
       in the repository was 2025-01-30.)  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
       [email protected]

Performance Co-Pilot               PCP            PMLOOKUPINDOMARCHIVE(3)

Pages that refer to this page: pcpintro(3)pmgetindomarchive(3)pmlookupindom(3)pmnameindomarchive(3)