pmFreeResult - Man Page

release storage allocated for performance metrics values

C Synopsis

#include <pcp/pmapi.h>

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

cc ... -lpcp


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

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

Referenced By

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

The man page pmFreeHighResResult(3) is an alias of pmFreeResult(3).

PCP Performance Co-Pilot