PMIGETHANDLE3()                                              PMIGETHANDLE3()

NAME         top

       pmiGetHandle - define a handle for a metric-instance pair

C SYNOPSIS         top

       #include <pcp/pmapi.h>
       #include <pcp/impl.h>
       #include <pcp/import.h>

       int pmiGetHandle(const char *name, const char *instance);

       cc ... -lpcp_import -lpcp

Perl SYNOPSIS         top

       use PCP::LogImport;

       $handle = pmiGetHandle($name, $instance);

DESCRIPTION         top

       As part of the Performance Co-Pilot Log Import API (see
       LOGIMPORT(3)), pmiGetHandle creates a handle for a given metric and
       instance.  The handle is returned as the value from the pmiGetHandle
       call and can be used in subsequent calls to pmiPutValueHandle(3).

       The metric's name should match one defined earlier in a call to

       For singular metrics (those defined with an instance domain of
       PM_INDOM_NULL), the instance should be NULL or an empty string,
       otherwise instance should match the name of an instance defined
       earlier in a call to pmiAddInstance(3) for the metric's instance

       When combined with pmiPutValueHandle(3), the use of handles provide a
       performance improvement over the alternative lookup for a metric name
       and an instance name for each data value that is required for

DIAGNOSTICS         top

       On failure pmiGetHandle returns a negative value that can be turned
       into an error message by calling pmiErrStr(3).

SEE ALSO         top

       LOGIMPORT(3), pmiAddInstance(3), pmiAddMetric(3), pmiErrStr(3) and

COLOPHON         top

       This page is part of the PCP (Performance Co-Pilot) project.
       Information about the project can be found at ⟨⟩.
       If you have a bug report for this manual page, send it to  This page was obtained from the project's upstream
       Git repository ⟨⟩ on
       2017-09-15.  If you discover any rendering problems in this HTML ver‐
       sion 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 man‐
       ual page), send a mail to

                            Performance Co-Pilot             PMIGETHANDLE3()

Pages that refer to this page: logimport(3)pmiaddinstance(3)pmiputvaluehandle(3)pmistart(3)