pmFreeResult - Man Page

release storage allocated for performance metrics values

C Synopsis

#include <pcp/pmapi.h>

void pmFreeResult(pmResult *result);

cc ... -lpcp

Description

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 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).

Compatibility

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 pmFreeHighResResult will be removed in a future release.

See Also

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

Referenced By

PMAPI(3), pmFetch(3), pmFetchArchive(3).

PCP Performance Co-Pilot