pmgetindom(3) — Linux manual page

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

PMGETINDOM(3)           Library Functions Manual           PMGETINDOM(3)

NAME         top

       pmGetInDom - get instance identifiers for a performance metrics
       instance domain

C SYNOPSIS         top

       #include <pcp/pmapi.h>

       int pmGetInDom(pmInDom indom, int **instlist, char ***namelist);

       cc ... -lpcp

DESCRIPTION         top

       In the current Performance Metrics Application Programming
       Interface (PMAPI) context, locate the description of the instance
       domain indom, and return via instlist the internal instance
       identifiers for all instances, and via namelist the full external
       identifiers for all instances.  The number of instances found is
       returned as the function value (else less than zero to indicate
       an error).

       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 resulting lists of instance identifiers (instlist and
       namelist), and the names that the elements of namelist point to,
       will have been allocated by pmGetInDom with two calls to
       malloc(3), and it is the responsibility of the caller to
       free(instlist) and free(namelist) to release the space when it is
       no longer required.

       When the result of pmGetInDom is less than one, both instlist and
       namelist are undefined (no space will have been allocated, and so
       calling free(3) is a singularly bad idea).

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), pmGetInDomArchive(3), pmLookupDesc(3),
       pmLookupInDom(3), pmNameInDom(3), pcp.conf(5) and pcp.env(5).

DIAGNOSTICS         top

       PM_ERR_INDOM
              indom is not a valid instance domain identifier

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 2021-04-01.
       (At that time, the date of the most recent commit that was found
       in the repository was 2021-04-01.)  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                     PMGETINDOM(3)

Pages that refer to this page: pmdumplog(1)pmlogextract(1)pmlogger(1)pcpintro(3)pmaddprofile(3)pmapi(3)pmdacache(3)pmdainstance(3)pmdelprofile(3)pmfetch(3)pmgetindomarchive(3)pmlookupindom(3)pmlookuplabels(3)pmnameindom(3)pmsetmode(3)pmwebapi(3)QmcIndom(3)