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

NAME

6       pmdaText - extract metric help text for a PMDA
7

C SYNOPSIS

9       #include <pcp/pmapi.h>
10       #include <pcp/impl.h>
11       #include <pcp/pmda.h>
12
13       int pmdaText(int ident, int type, char **buffer, pmdaExt *pmda);
14
15       cc ... -lpcp_pmda -lpcp
16

DESCRIPTION

18       As  part  of  the  Performance  Metrics  Domain  Agent  (PMDA) API (see
19       PMDA(3)), pmdaText uses the standard PMDA(3) data structures to  return
20       the  help  text  for  metric  ident  in  buffer.  The help text must be
21       located in help text files created with newhelp(1), and the  associated
22       files are automatically opened by pmdaInit(3).
23
24       The  path  to  the  (basename of the) help text files can be set in the
25       calls to pmdaDSO(3) or pmdaDaemon(3) and overridden by the  -h  command
26       line option in pmdaGetOpt(3).
27
28       The  encoding  of ident follows the internal scheme used below the rou‐
29       tines pmLookupText(3) and pmLookupInDomText(3),  namely  ident  encodes
30       either  a metric identifier or an instance domain identifier, according
31       to the value of type.
32
33       The type argument is a bit mask  that  encodes  the  interpretation  of
34       ident  and  the  requested  form  of  help  text,  as  follows:  either
35       PM_TEXT_PMID if ident is a metric identifier, or PM_TEXT_INDOM if ident
36       is  an  instance domain identifier, plus either PM_TEXT_ONELINE for the
37       one line help text or PM_TEXT_HELP for the full help text.
38
39       The buffer is managed internally (usually it is cached), and it  should
40       not be released or freed by the caller of pmdaText.
41

DIAGNOSTICS

43       If  the requested help text could not be obtained, pmdaText will return
44       PM_ERR_TEXT.
45

CAVEAT

47       The PMDA must be using PMDA_PROTOCOL_2 or later, as  specified  in  the
48       call to pmdaDSO(3) or pmdaDaemon(3).
49

SEE ALSO

51       newhelp(1),  malloc(3),  PMAPI(3),  PMDA(3), pmdaDaemon(3), pmdaDSO(3),
52       pmdaInit(3), pmLookupInDomText(3) and pmLookupText(3).
53
54
55
56Performance Co-Pilot                  PCP                          PMDATEXT(3)
Impressum