1PMLOOKUPTEXT(3) Library Functions Manual PMLOOKUPTEXT(3)
2
3
4
6 pmLookupText - return text describing a performance metric
7
9 #include <pcp/pmapi.h>
10
11 int pmLookupText(pmID pmid, int level, char **buffer);
12
13 cc ... -lpcp
14
16 Provided the source of metrics from the current Performance Metrics
17 Application Programming Interface (PMAPI) context is a host, retrieve
18 descriptive text about the performance metric identified by pmid.
19
20 The argument level should be PM_TEXT_ONELINE for a one-line summary,
21 else PM_TEXT_HELP for a more verbose description, suited to a help dia‐
22 log.
23
24 The space pointed to by buffer will have been allocated in pmLookupText
25 with malloc(3), and it is the responsibility of the caller to free(3)
26 the space when it is no longer required.
27
28 pmLookupText returns zero on success.
29
31 chkhelp(1), newhelp(1), PMAPI(3), pmGetConfig(3), pmLookupDesc(3),
32 pmLookupInDomText(3), pcp.conf(5) and pcp.env(5).
33
35 PM_ERR_NOTHOST
36 if the current PMAPI context is an archive log (help and one-
37 line text is not maintained in the archive logs)
38
39
40
41Performance Co-Pilot PCP PMLOOKUPTEXT(3)