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       Provided the source of metrics from  the  current  Performance  Metrics
18       Application  Programming  Interface (PMAPI) context is a host, retrieve
19       descriptive text about the performance metrics instance domain  identi‐
20       fied by indom.
21
22       The  value  for the instance domain indom is typically extracted from a
23       pmDesc structure, following a call to pmLookupDesc(3) for a  particular
24       performance metric.
25
26       The  argument  level  should be PM_TEXT_ONELINE for a one-line summary,
27       else PM_TEXT_HELP for a more verbose description, suited to a help dia‐
28       log.
29
30       The  space pointed to by buffer will have been allocated in pmLookupIn‐
31       DomText with malloc(3), and it is the responsibility of the  caller  to
32       free(3) the space when it is no longer required.
33
34       pmLookupInDomText returns zero on success.
35

SEE ALSO

37       chkhelp(1),   newhelp(1),  PMAPI(3),  pmGetConfig(3),  pmLookupDesc(3),
38       pmLookupText(3), pcp.conf(5) and pcp.env(5).
39

DIAGNOSTICS

41       PM_ERR_NOTHOST
42              if the current PMAPI context is an archive log  (help  and  one-
43              line text is not maintained in the archive logs)
44
45
46
47Performance Co-Pilot                  PCP                 PMLOOKUPINDOMTEXT(3)
Impressum