|
NAME | C SYNOPSIS | DESCRIPTION | SEE ALSO | DIAGNOSTICS | COLOPHON |
PMLOOKUPINDOMTEXT(3) Library Functions Manual PMLOOKUPINDOMTEXT(3)
pmLookupInDomText - return text describing a performance metrics
instance domain
#include <pcp/pmapi.h>
int pmLookupInDomText(pmInDom indom, int level, char **buffer);
cc ... -lpcp
Provided the source of metrics from the current Performance Metrics
Application Programming Interface (PMAPI) context is a host, 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 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
pmLookupInDomText 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.
chkhelp(1), newhelp(1), PMAPI(3), pmGetConfig(3), pmLookupDesc(3),
pmLookupText(3), pcp.conf(5) and pcp.env(5).
PM_ERR_NOTHOST
if the current PMAPI context is an archive log (help and one-
line text is not maintained in the archive logs)
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@oss.sgi.com. This page was obtained from the project's upstream
Git repository ⟨git://git.pcp.io/pcp⟩ on 2017-07-05. 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)