pmiputtext(3) — Linux manual page

PMIPUTTEXT(3)           Library Functions Manual           PMIPUTTEXT(3)

NAME

       pmiPutText - add help text for an metric or instance domain

C SYNOPSIS

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

       int pmiPutText(unsigned int type, unsigned int class, unsigned
               int id, const char *content);

       cc ... -lpcp_import -lpcp

Perl SYNOPSIS

       use PCP::LogImport;

       pmiPutText($type, $class, $id, $content);

DESCRIPTION

       As   part  of  the  Performance  Co-Pilot  Log  Import  API  (see
       LOGIMPORT(3)), pmiPutText adds help text for a  given  metric  or
       instance domain.

       The type must be one of PM_TEXT_PMID or PM_TEXT_INDOM.

       The class must be one of PM_TEXT_ONELINE or PM_TEXT_HELP.

       If type is PM_TEXT_PMID, then id should match a pmid defined ear‐
       lier  in  a  call  to pmiAddMetric(3).  If type is PM_TEXT_INDOM,
       then id should match an instance domain defined earlier in a call
       to pmiAddMetric(3).

       content is a string containing the content of the help text.

       No data will be written until pmiWrite(3) is called, so  multiple
       calls  to  pmiPutText  are typically used to accumulate help text
       for  several  metrics  or   instance   domains   before   calling
       pmiWrite(3).

DIAGNOSTICS

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

SEE ALSO

       LOGIMPORT(3),  pmiAddInstance(3),  pmiAddMetric(3), pmiErrStr(3),
       pmiPutResult(3),      pmiPutValue(3),       pmiPutValueHandle(3),
       pmiPutLabel(3) and pmiWrite(3).

COLOPHON

       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   2024-06-14.
       (At  that time, the date of the most recent commit that was found
       in the repository was 2024-06-14.)  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                                       PMIPUTTEXT(3)

Pages that refer to this page: logimport(3), pmiaddinstance(3), pmiaddmetric(3), pmiputlabel(3), pmiputmark(3), pmiputresult(3), pmiputvalue(3), pmiputvaluehandle(3), pmistart(3), pmiwrite(3)

---