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

NAME

6       pmLookupInDomText  -  return  text  describing  a  performance  metrics
7       instance domain
8

C SYNOPSIS

10       #include <pcp/pmapi.h>
11
12       int pmLookupInDomText(pmInDom indom, int level, char **buffer);
13
14       cc ... -lpcp
15

DESCRIPTION

17       Retrieve descriptive text about the performance metrics instance domain
18       identified by indom.
19
20       The  value  for the instance domain indom is typically extracted from a
21       pmDesc structure, following a call to pmLookupDesc(3) for a  particular
22       performance metric.
23
24       The  argument  level  should be PM_TEXT_ONELINE for a one-line summary,
25       else PM_TEXT_HELP for a more verbose description, suited to a help dia‐
26       log.
27
28       The  space pointed to by buffer will have been allocated in pmLookupIn‐
29       DomText with malloc(3), and it is the responsibility of the  caller  to
30       free(3) the space when it is no longer required.
31
32       pmLookupInDomText returns zero on success.
33

DIAGNOSTICS

35       PM_ERR_NOTHOST
36              For  archives  created with versions of PCP prior to 4.0, if the
37              current PMAPI context is an archive log (help and one-line  text
38              was previously not maintained in the archive logs)
39

SEE ALSO

41       chkhelp(1),   newhelp(1),  PMAPI(3),  pmGetConfig(3),  pmLookupDesc(3),
42       pmLookupLabels(3), pmLookupText(3), pcp.conf(5) and pcp.env(5).
43
44
45
46Performance Co-Pilot                  PCP                 PMLOOKUPINDOMTEXT(3)