1PMLOOKUPTEXT(3)            Library Functions Manual            PMLOOKUPTEXT(3)
2
3
4

NAME

6       pmLookupText - return text describing a performance metric
7

C SYNOPSIS

9       #include <pcp/pmapi.h>
10
11       int pmLookupText(pmID pmid, int level, char **buffer);
12
13       cc ... -lpcp
14

DESCRIPTION

16       Retrieve  descriptive  text  about the performance metric identified by
17       pmid.
18
19       The argument level should be  either  PM_TEXT_ONELINE  for  a  one-line
20       summary,  else PM_TEXT_HELP for a more verbose description, suited to a
21       help dialog.
22
23       The space pointed to by buffer will have been allocated in pmLookupText
24       with  malloc(3),  and it is the responsibility of the caller to free(3)
25       the space when it is no longer required.
26
27       pmLookupText returns zero on success.
28

DIAGNOSTICS

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

SEE ALSO

36       chkhelp(1),  newhelp(1),  PMAPI(3),  pmGetConfig(3),   pmLookupDesc(3),
37       pmLookupLabels(3), pmLookupInDomText(3), pcp.conf(5) and pcp.env(5).
38
39
40
41Performance Co-Pilot                  PCP                      PMLOOKUPTEXT(3)