pmfreeeventresult(3) — Linux manual page

PMFREEEVENTRESULT(3)     Library Functions Manual    PMFREEEVENTRESULT(3)

NAME         top

       pmFreeHighResEventResult, pmFreeEventResult - release storage
       allocated for unpacked event records

C SYNOPSIS         top

       #include <pcp/pmapi.h>

       void pmFreeHighResEventResult(pmResult **hrset);
       void pmFreeEventResult(pmResult_v2 **rset);

       cc ... -lpcp

DESCRIPTION         top

       When  processing  event records, if pmUnpackHighResEventRecords(3)
       is used to unpack event records from a metric  within  a  pmResult
       structure  with  a  value  of  type PM_TYPE_HIGHRES_EVENT then the
       structure returned from pmUnpackHighResEventRecords(3) is  a  NULL
       pointer  terminated  array of pointers to pmResult structures, one
       for each event record.

       pmFreeHighResEventResult is a convenience method that frees all of
       the pmResult structures and the array of pointers (hrset).

       Similarly, pmFreeEventResult may be used to free  the  pmResult_v2
       structures  and  array returned from the pmUnpackEventRecords rou‐
       tine when using PM_TYPE_EVENT metrics.

SEE ALSO         top

       PMAPI(3) and pmUnpackEventRecords(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-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 man-pages@man7.org

Performance Co-Pilot               PCP               PMFREEEVENTRESULT(3)

Pages that refer to this page: pmunpackeventrecords(3)

HTML rendering created 2025-09-06 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.