NAME¶
pmLookupText - return text describing a performance metric
C SYNOPSIS¶
#include <pcp/pmapi.h>
int pmLookupText(pmID pmid, int level, char **buffer);
cc ... -lpcp
DESCRIPTION¶
Provided the source of metrics from the current Performance Metrics Application
Programming Interface (PMAPI) context is a host, retrieve descriptive text
about the performance metric identified by
pmid.
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
pmLookupText with
malloc(3C), and it is the responsibility of
the caller to
free(3C) the space when it is no longer required.
pmLookupText returns zero on success.
SEE ALSO¶
chkhelp(1),
newhelp(1),
PMAPI(3),
pmGetConfig(3),
pmLookupDesc(3),
pmLookupInDomText(3),
pcp.conf(5) and
pcp.env(5).
DIAGNOSTICS¶
- PM_ERR_NOTHOST
- if the current PMAPI context is an archive log (help and one-line text is
not maintained in the archive logs)
