pmprintvalue(3) — Linux manual page

NAME | C SYNOPSIS | DESCRIPTION | ENVIRONMENT | SEE ALSO | COLOPHON

PMPRINTVALUE(3)          Library Functions Manual         PMPRINTVALUE(3)

NAME         top

       pmPrintValue - print a performance metric value

C SYNOPSIS         top

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

       void pmPrintValue(FILE *f, int valfmt, int type,
               const pmValue *val, int minwidth);

       cc ... -lpcp

DESCRIPTION         top

       The value of a single performance metric (as identified by val) is
       printed on the standard I/O stream identified by f.

       The  value  of  the performance metric is interpreted according to
       the format of val as defined by valfmt (from a pmValueSet within a
       pmResult structure; see pmFetch(3)) and the generic description of
       the metrics type passed in via type.

       The value for type is typically extracted from a pmDesc structure,
       following a call to pmLookupDesc(3) for a  particular  performance
       metric.

       The output will be optionally padded to be at least minwidth char‐
       acters wide.

       pmPrintValue  is  most useful for displaying values of performance
       metrics from pmFetch(3) (which returns a set  of  valfmt  and  val
       pairs  for  each requested metric), based upon the metrics type as
       returned from pmLookupDesc(3).

ENVIRONMENT         top

       Output of string metric values can  be  further  controlled  using
       PCP_SQUASH_NEWLINES.   When  set in the environment of the calling
       process, and the type is set to PM_TYPE_STRING  or  PM_TYPE_AGGRE‐
       GATE,  then  the output value is guaranteed to be free of embedded
       newline characters.  If the given value contained such characters,
       they will have been replaced by a space before being printed.

SEE ALSO         top

       PMAPI(3),   pmAtomStr(3),    pmConvScale(3),    pmExtractValue(3),
       pmFetch(3), pmLookupDesc(3), pmTypeStr(3) and pmUnitsStr(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
       2025-02-02.   (At  that  time,  the date of the most recent commit
       that was found in the repository was 2025-01-30.)  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               PCP                    PMPRINTVALUE(3)

Pages that refer to this page: pmprobe(1)pmapi(3)pmatomstr(3)pmconvscale(3)pmextractvalue(3)pmsemstr(3)pmtypestr(3)pmunitsstr(3)