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

PMNAMEALL(3)              Library Functions Manual              PMNAMEALL(3)

NAME         top

       pmNameAll - translate a PMID to a set of performance metric names

C SYNOPSIS         top

       #include <pcp/pmapi.h>

       int pmNameAll(pmID pmid, char ***nameset);

       cc ... -lpcp

DESCRIPTION         top

       Given a Performance Metric Identifier (PMID) via pmid, pmNameAll will
       determine all the corresponding metric names, if any, in the
       Performance Metrics Name Space (PMNS), and return these via nameset.

       The resulting list of pointers nameset and the values (the relative
       names) that the pointers reference will have been allocated by
       pmNameAll with a single call to malloc(3), and it is the
       responsibility of the pmNameAll caller to use free(nameset) to
       release the space when it is no longer required.

       In the absence of errors, pmNameAll returns the number of names in
       nameset.

       For many examples of a PMNS, there will be a 1:1 mapping between a
       name and a PMID, and under these circumstances, pmNameID(3) provides
       a slightly simpler interface in the absence of duplicate names for a
       particular PMID.

SEE ALSO         top

       PMAPI(3), pmGetChildren(3), pmGetChildrenStatus(3), pmGetConfig(3),
       pmLoadASCIINameSpace(3), pmLoadNameSpace(3), pmLookupName(3),
       pmNameID(3), pmNewContext(3), pcp.conf(5), pcp.env(5) and pmns(5).

DIAGNOSTICS         top

       PM_ERR_NOPMNS
              Failed to access a PMNS for operation.  Note that if the
              application hasn't a priori called pmLoadNameSpace(3) and
              wants to use the distributed PMNS, then a call to pmNameAll
              must be made after the creation of a context (see
              pmNewContext(3)).

       PM_ERR_PMID
              pmid does not correspond to a defined PMID in the PMNS.

       PM_ERR_*
              Other diagnostics are for protocol failures when accessing the
              distributed PMNS.

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
       2017-11-25.  (At that time, the date of the most recent commit that
       was found in the repository was 2017-11-24.)  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                        PMNAMEALL(3)

Pages that refer to this page: pmdaname(3)pmnameid(3)