NAME
pmDestroyContext - destroy a PMAPI context
C SYNOPSIS
#include <pcp/pmapi.h>
int pmDestroyContext(int handle)
cc ... -lpcp
DESCRIPTION
An application using the Performance Metrics Application
Programming Interface (PMAPI) may manipulate several con
current contexts, each associated with a source of perfor
mance metrics, e.g. pmcd(1) on some host, or an archive
log of performance metrics as created by pmlogger(1).
pmDestroyContext destroys the PMAPI context identified by
handle. Typically this would imply some termination of a
connection to a PMCD or closing an archive log file, and
orderly clean-up.
The context must have been previously created using pmNew
Context(3) or pmDupContext(3).
On success, pmDestroyContext returns zero. If handle was
the current PMAPI context, then the current context
becomes undefined. This means the application must
explicitly re-establish a valid PMAPI context with pmUseC
ontext(3), or create a new context with pmNewContext(3) or
pmDupContext(3), before the next PMAPI operation that
requires a PMAPI context.
SEE ALSO
PMAPI(3), pmDupContext(3), pmNewContext(3), pmUseCon
text(3) and pmWhichContext(3).
DIAGNOSTICS
PM_ERR_NOCONTEXT
handle does not identify a valid PMAPI context
Man(1) output converted with
man2html