pmfreeresult(3) — Linux manual page

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

PMFREERESULT(3)          Library Functions Manual         PMFREERESULT(3)

NAME         top

       pmFreeResult - release storage allocated for performance metrics
       values

C SYNOPSIS         top

       #include <pcp/pmapi.h>

       void pmFreeResult(pmResult *result);

       cc ... -lpcp

DESCRIPTION         top

       The  variable  sized  results returned by pmFetch(3) are allocated
       below the Performance Metrics  Application  Programming  Interface
       (PMAPI)  using  a combination of dynamic (i.e. malloc(3)) and spe‐
       cialized allocation strategies.

       Applications should call pmFreeResult to release the storage  pre‐
       viously  allocated  for result by pmFetch(3), when the application
       no longer requires access to the pmResult structure.

       Under no circumstances should an application use  free(result)  to
       release storage previously allocated for a pmResult by pmFetch(3).

COMPATIBILITY         top

       Prior  to PCP 7.0 the timestamp field in the pmResult struct was a
       struct timeval.  To support PMAPI transition,  the  old  interface
       and  semantics  can  be  used  if applications are recompiled with
       -DPMAPI_VERSION=2.

       For a time in PCP 6.x there was a routine with the same  semantics
       as  the  current  pmFreeResult called pmFreeHighResResult although
       this is now deprecated and compile-time support for pmFreeHighRes‐
       Result will be removed in a future release.

SEE ALSO         top

       PMAPI(3), malloc(3) and pmFetch(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
       [email protected].  This page was obtained from the project's upstream
       Git  repository ⟨https://github.com/performancecopilot/pcp.git⟩ on
       2025-08-11.  (At that time, the date of  the  most  recent  commit
       that was found in the repository was 2025-08-11.)  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 [email protected]

Performance Co-Pilot               PCP                    PMFREERESULT(3)

Pages that refer to this page: pmapi(3)pmfetch(3)pmfetcharchive(3)