pmfreeresult(3) — Linux manual page

NAME | C SYNOPSIS | DESCRIPTION | SEE ALSO | COLOPHON

PMFREERESULT(3)         Library Functions Manual         PMFREERESULT(3)

NAME         top

       pmFreeResult, pmFreeHighResResult, - release storage allocated
       for performance metrics values

C SYNOPSIS         top

       #include <pcp/pmapi.h>

       void pmFreeResult(pmResult *result);
       void pmFreeHighResResult(pmHighResResult *result);

       cc ... -lpcp

DESCRIPTION         top

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

       Applications should call pmFreeResult to release the storage
       previously 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).

       Similarly, memory allocated for the high resolution timestamped
       result structure returned from pmHighResFetch(3) should be
       released by a call to pmFreeHighResResult.

SEE ALSO         top

       malloc(3), PMAPI(3), pmFetch(3) and pmHighResFetch(3).

COLOPHON         top

       This page is part of the PCP (Performance Co-Pilot) project.
       Information 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 2021-06-20.
       (At that time, the date of the most recent commit that was found
       in the repository was 2021-06-19.)  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                   PMFREERESULT(3)

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