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

NAME

6       pmiPutValue - add a value for a metric-instance pair
7

C SYNOPSIS

9       #include <pcp/pmapi.h>
10       #include <pcp/import.h>
11
12       int pmiPutValue(const char *name, const char *instance,
13               const char *value);
14
15       cc ... -lpcp_import -lpcp
16

Perl SYNOPSIS

18       use PCP::LogImport;
19
20       pmiPutValue($name, $instance, $value);
21

DESCRIPTION

23       As part of the Performance Co-Pilot Log Import API (see  LOGIMPORT(3)),
24       pmiPutValue adds a single value to the current output record for a giv‐
25       en metric and instance.
26
27       The metric's name should match one defined earlier in a call to pmiAdd‐
28       Metric(3).
29
30       For  singular  metrics (those defined with an instance domain of PM_IN‐
31       DOM_NULL), the instance should be NULL or an  empty  string,  otherwise
32       instance should match the name of an instance defined earlier in a call
33       to pmiAddInstance(3) for the metric's instance domain.
34
35       The value should be in a format consistent with the  metric's  type  as
36       defined in the call to pmiAddMetric(3).
37
38       No  data will be written until pmiWrite(3) is called, so multiple calls
39       to pmiPutValue or pmiPutValueHandle(3) are typically used to accumulate
40       data  values  for  several  metric-instance  pairs  before calling pmi‐
41       Write(3).
42

DIAGNOSTICS

44       pmiPutValue returns zero on success else a negative value that  can  be
45       turned into an error message by calling pmiErrStr(3).
46

SEE ALSO

48       LOGIMPORT(3),  pmiAddInstance(3), pmiAddMetric(3), pmiErrStr(3), pmiPu‐
49       tResult(3),  pmiPutValueHandle(3),  pmiPutText(3),  pmiPutLabel(3)  and
50       pmiWrite(3).
51
52
53
54Performance Co-Pilot                                            PMIPUTVALUE(3)