pmiputvaluehandle(3) — Linux manual page

NAME | C SYNOPSIS | Perl SYNOPSIS | Python SYNOPSIS | DESCRIPTION | DIAGNOSTICS | SEE ALSO | COLOPHON

PMIPUTVALUEHANDLE(3)     Library Functions Manual    PMIPUTVALUEHANDLE(3)

NAME         top

       pmiPutAtomValueHandle, pmiPutValueHandle - add a value for a
       metric-instance pair via a handle

C SYNOPSIS         top

       #include <pcp/pmapi.h>
       #include <pcp/import.h>

       int pmiPutAtomValueHandle(int handle, pmAtomValue *atom);
       int pmiPutValueHandle(int handle, const char *value);

       cc ... -lpcp_import -lpcp

Perl SYNOPSIS         top

       use PCP::LogImport;

       pmiPutValueHandle($handle, $value);

Python SYNOPSIS         top

       from pcp import pmi

       log.pmiPutValueHandle(handle, value)

DESCRIPTION         top

       As   part   of  the  Performance  Co-Pilot  Log  Import  API  (see
       LOGIMPORT(3)), pmiPutAtomValueHandle and pmiPutValueHandle  add  a
       single  value  to the current output record for a given metric and
       instance,  using  the  handle  defined  by  an  earlier  call   to
       pmiGetHandle(3).

       With  pmiPutAtomValueHandle  the  atom passes the binary value di‐
       rectly using a union of types.

       In the case of pmiPutValueHandle the value should be in  a  format
       consistent  with  the  metric's  type  as  defined  in the call to
       pmiAddMetric(3).

       No data will be written until pmiWrite(3) is called,  so  multiple
       calls     to     pmiPutAtomValueHandle,    pmiPutValueHandle    or
       pmiPutValue(3) are typically used to accumulate  data  values  for
       several metric-instance pairs before calling pmiWrite(3).

DIAGNOSTICS         top

       pmiPutAtomValueHandle and pmiPutValueHandle return zero on success
       else  a negative value that can be turned into an error message by
       calling pmiErrStr(3).

SEE ALSO         top

       LOGIMPORT(3),  pmiErrStr(3),   pmiGetHandle(3),   pmiPutResult(3),
       pmiPutValue(3), pmiPutText(3), pmiPutLabel(3) and pmiWrite(3).

COLOPHON         top

       This  page is part of the PCP (Performance Co-Pilot) project.  In‐
       formation about the project can be found at  ⟨http://www.pcp.io/⟩.
       If  you  have  a  bug  report  for  this  manual  page, send it to
       pcp@groups.io.  This page was obtained from the project's upstream
       Git repository ⟨https://github.com/performancecopilot/pcp.git⟩  on
       2026-08-04.   (At  that  time,  the date of the most recent commit
       that was found in the repository was 2026-08-04.)  If you discover
       any rendering problems in this HTML version of the  page,  or  you
       believe  there is a better or more up-to-date source for the page,
       or you have corrections or improvements to the information in this
       COLOPHON (which is not part of the original manual page),  send  a
       mail to man-pages@man7.org

Performance Co-Pilot                                 PMIPUTVALUEHANDLE(3)

Pages that refer to this page: logimport(3)pmiaddmetric(3)pmigethandle(3)pmiputlabel(3)pmiputmark(3)pmiputresult(3)pmiputtext(3)pmiputvalue(3)pmistart(3)pmiwrite(3)