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

NAME

6       pmiPutText - add help text for an metric or instance domain
7

C SYNOPSIS

9       #include <pcp/pmapi.h>
10       #include <pcp/import.h>
11
12       int pmiPutText(unsigned int type, unsigned int class, unsigned int id,
13               const char *content)
14
15       cc ... -lpcp_import -lpcp
16

Perl SYNOPSIS

18       use PCP::LogImport;
19
20       pmiPutText($type, $class, $id, $content);
21

DESCRIPTION

23       As part of the Performance Co-Pilot Log Import API (see  LOGIMPORT(3)),
24       pmiPutText adds help text for a given metric or instance domain.
25
26       The type must be one of PM_TEXT_PMID or PM_TEXT_INDOM.
27
28       The class must be one of PM_TEXT_ONELINE or PM_TEXT_HELP.
29
30       If type is PM_TEXT_PMID, then id should match a pmid defined earlier in
31       a call to pmiAddMetric(3).  If type is PM_TEXT_INDOM,  then  id  should
32       match an instance domain defined earlier in a call to pmiAddMetric(3).
33
34       content is a string containing the content of the help text.
35
36       No  data will be written until pmiWrite(3) is called, so multiple calls
37       to pmiPutText are typically used to accumulate help  text  for  several
38       metrics or instance domains before calling pmiWrite(3).
39

DIAGNOSTICS

41       pmiPutText  returns  zero  on success else a negative value that can be
42       turned into an error message by calling pmiErrStr(3).
43

SEE ALSO

45       LOGIMPORT(3), pmiAddInstance(3), pmiAddMetric(3), pmiErrStr(3),  pmiPu‐
46       tResult(3),  pmiPutValue(3),  pmiPutValueHandle(3),  pmiPutLabel(3) and
47       pmiWrite(3).
48
49
50
51Performance Co-Pilot                                             PMIPUTTEXT(3)