NAME | C SYNOPSIS | DESCRIPTION | SEE ALSO | DIAGNOSTICS | COLOPHON

PMDESTROYCONTEXT(3)       Library Functions Manual       PMDESTROYCONTEXT(3)

NAME         top

       pmDestroyContext - destroy a PMAPI context

C SYNOPSIS         top

       #include <pcp/pmapi.h>

       int pmDestroyContext(int handle);

       cc ... -lpcp

DESCRIPTION         top

       An application using the Performance Metrics Application Programming
       Interface (PMAPI) may manipulate several concurrent contexts, each
       associated with a source of performance 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 pmNewContext(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 pmUseContext(3), or create a new context with
       pmNewContext(3) or pmDupContext(3), before the next PMAPI operation
       that requires a PMAPI context.

SEE ALSO         top

       PMAPI(3), pmDupContext(3), pmNewContext(3), pmUseContext(3) and
       pmWhichContext(3).

DIAGNOSTICS         top

       PM_ERR_NOCONTEXT

              handle does not identify a valid PMAPI context

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
       2017-11-25.  (At that time, the date of the most recent commit that
       was found in the repository was 2017-11-24.)  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                 PMDESTROYCONTEXT(3)

Pages that refer to this page: pcpintro(3)pmapi(3)pmnewcontext(3)pmusecontext(3)pmwhichcontext(3)