pmlookupindomtext(3) — Linux manual page

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

PMLOOKUPINDOMTEXT(3)     Library Functions Manual    PMLOOKUPINDOMTEXT(3)

NAME         top

       pmLookupInDomText - return text describing a performance metrics
       instance domain

C SYNOPSIS         top

       #include <pcp/pmapi.h>

       int pmLookupInDomText(pmInDom indom, int level, char **buffer);

       cc ... -lpcp

DESCRIPTION         top

       Retrieve  descriptive  text about the performance metrics instance
       domain identified by indom.

       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 argument level should be PM_TEXT_ONELINE for a one-line summa‐
       ry,  else PM_TEXT_HELP for a more verbose description, suited to a
       help dialog.

       The space pointed to by buffer will have  been  allocated  in  pm‐
       LookupInDomText  with  malloc(3),  and it is the responsibility of
       the caller to free(3) the space when it is no longer required.

       pmLookupInDomText returns zero on success.

DIAGNOSTICS         top

       PM_ERR_NOTHOST
              For archives created with versions of PCP prior to 4.0, if
              the current PMAPI context is an archive (help and one-line
              text was previously not maintained in the archives)

SEE ALSO         top

       chkhelp(1), newhelp(1), PMAPI(3), pmGetConfig(3), pmLookupDesc(3),
       pmLookupLabels(3), pmLookupText(3), pcp.conf(5) and pcp.env(5).

COLOPHON         top

       This page is part of the PCP (Performance Co-Pilot) project.  In‐
       formation 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
       2025-08-11.  (At that time, the date of the most recent commit
       that was found in the repository was 2025-08-11.)  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               PMLOOKUPINDOMTEXT(3)

Pages that refer to this page: chkhelp(1)newhelp(1)pcpintro(3)pmdatext(3)pmlookuptext(3)LOGARCHIVE(5)