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

PMLOOKUPTEXT(3)           Library Functions Manual           PMLOOKUPTEXT(3)

NAME         top

       pmLookupText - return text describing a performance metric

C SYNOPSIS         top

       #include <pcp/pmapi.h>

       int pmLookupText(pmID pmid, int level, char **buffer);

       cc ... -lpcp

DESCRIPTION         top

       Retrieve descriptive text about the performance metric identified by
       pmid.

       The argument level should be  either PM_TEXT_ONELINE for a one-line
       summary, 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
       pmLookupText with malloc(3), and it is the responsibility of the
       caller to free(3) the space when it is no longer required.

       pmLookupText 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 log (help and one-line
              text was previously not maintained in the archive logs)

SEE ALSO         top

       chkhelp(1), newhelp(1), PMAPI(3), pmGetConfig(3), pmLookupDesc(3),
       pmLookupLabels(3), pmLookupInDomText(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
       pcp@groups.io.  This page was obtained from the project's upstream
       Git repository ⟨https://github.com/performancecopilot/pcp.git⟩ on
       2018-04-30.  (At that time, the date of the most recent commit that
       was found in the repository was 2018-04-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
       man-pages@man7.org

Performance Co-Pilot                 PCP                     PMLOOKUPTEXT(3)

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