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/pmda.h>
12
13       int pmdaOpenHelp(const char *fname);
14       char *pmdaGetHelp(int handle, pmID pmid, int type);
15       char *pmdaGetInDomHelp(int handle, pmInDom indom, int type);
16       void pmdaCloseHelp(int handle);
17
18       cc ... -lpcp_pmda -lpcp
19

DESCRIPTION

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

CAVEAT

41       The  PMDA  must  be using PMDA_PROTOCOL_2 or later, as specified in the
42       call to pmdaDSO(3) or pmdaDaemon(3).
43

DIAGNOSTICS

45       pmdaOpenHelp returns a negative value for failure, suitable for  decod‐
46       ing  with pmErrStr(3).  pmdaGetHelp and pmdaGetInDomHelp return NULL if
47       the corresponding help text does not exist.
48

SEE ALSO

50       newhelp(1), PMAPI(3), PMDA(3), pmdaDaemon(3), pmdaDSO(3),  pmdaInit(3),
51       pmdaText(3) and pmErrStr(3).
52
53
54
55Performance Co-Pilot                  PCP                          PMDAHELP(3)
Impressum