pmfreelabelsets(3) — Linux manual page

PMFREELABELSETS(3)      Library Functions Manual      PMFREELABELSETS(3)

NAME         top

       pmFreeLabelSets - release storage allocated for performance
       metric labels

C SYNOPSIS         top

       #include <pcp/pmapi.h>

       void pmFreeLabelSets(pmLabelSet *sets, int nsets);

       cc ... -lpcp

DESCRIPTION         top

       The array of label sets returned by pmLookupLabels(3) and related
       APIs are allocated below the Performance Metrics Application
       Programming Interface (PMAPI) using a variety of calls to the
       system's dynamic memory allocation (i.e. malloc(3)) interfaces.

       Applications should call pmFreeLabelSets to release the storage
       previously allocated for the label sets array when access to the
       structure is no longer needed.  The return value from
       pmLookupLabels indicates the number of elements in the label sets
       array, and this should be passed in using the nsets parameter.

       Under no circumstances should an application use free(labelset)
       to release storage previously allocated for a pmLabelSet by
       pmLookupLabels(3) or related APIs.

       To simplify error handling, if sets is NULL then pmFreeLabelSets
       simply returns without freeing any storage.

SEE ALSO         top

       malloc(3), PMAPI(3) and pmLookupLabels(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 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               PCP                PMFREELABELSETS(3)

Pages that refer to this page: pmapi(3),  pmlookuplabels(3)

HTML rendering created 2024-06-26 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.