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/pmda.h>
11
12       int pmdaText(int ident, int type, char **buffer, pmdaExt *pmda);
13
14       cc ... -lpcp_pmda -lpcp
15

DESCRIPTION

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

DIAGNOSTICS

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

CAVEAT

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

SEE ALSO

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