pmFreeHighResEventResult - Man Page

release storage allocated for unpacked event records

C Synopsis

#include <pcp/pmapi.h>

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

cc ... -lpcp

Description

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 routine when using PM_TYPE_EVENT metrics.

See Also

PMAPI(3) and pmUnpackEventRecords(3).

Referenced By

pmUnpackHighResEventRecords(3).

The man page pmFreeEventResult(3) is an alias of pmFreeHighResEventResult(3).

PCP Performance Co-Pilot