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

NAME

6       pmdaOpenHelp,  pmdaGetHelp, pmdaGetInDomHelp, pmdaCloseHelp - help text
7       support for a PMDA
8

C SYNOPSIS

10       #include <pcp/pmapi.h>
11       #include <pcp/impl.h>
12       #include <pcp/pmda.h>
13
14       int pmdaOpenHelp(char *fname);
15       char *pmdaGetHelp(int handle, pmID pmid, int type);
16       char *pmdaGetInDomHelp(int handle, pmInDom indom, int type);
17       void pmdaCloseHelp(int handle);
18
19       cc ... -lpcp_pmda -lpcp
20

DESCRIPTION

22       As part of  the  Performance  Metrics  Domain  Agent  (PMDA)  API  (see
23       PMDA(3)), this group of routines is used to implement the processing of
24       a PMDA's metric help information.
25
26       These routines are really intended for internal  use,  and  should  not
27       need to be called directly from any PMDA code.
28
29       Briefly, the base name of the help text file (as created by newhelp(1))
30       is passed in via a -h command line option for a daemon PMDA  or  as  an
31       argument  to  pmdaDaemon(3) or pmdaDSO(3).  Then pmdaOpenHelp is called
32       from pmdaInit(3) and returns a handle that is used in subsequent  calls
33       to  identify a particular help text collection (each PMDA typically has
34       only one such collection).
35
36       Requests for help text are passed to pmdaText(3) which calls  pmdaGetH‐
37       elp or pmdaGetInDomHelp as required.
38
39       Other than error cases in pmdaOpenHelp, pmdaCloseHelp is not called.
40

DIAGNOSTICS

42       pmdaOpenHelp  returns a negative value for failure, suitable for decod‐
43       ing with pmErrStr(3).  pmdaGetHelp and pmdaGetInDomHelp return NULL  if
44       the corresponding help text does not exist.
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), PMAPI(3), PMDA(3), pmdaDaemon(3), pmdaDSO(3),  pmdaInit(3),
52       pmdaText(3) and pmErrStr(3).
53
54
55
56Performance Co-Pilot                  PCP                          PMDAHELP(3)
Impressum