NAME¶
pmdaDesc - get the description of a metric from a PMDA
C SYNOPSIS¶
#include <pcp/pmapi.h>
#include <pcp/impl.h>
#include <pcp/pmda.h>
int pmdaDesc(pmID
pmid, pmDesc *
desc, pmdaExt *
pmda);
cc ... -lpcp_pmda -lpcp
DESCRIPTION¶
pmdaDesc uses the standard
PMDA(3) data structures to return the
pmDesc description in
desc for the metric identified by
pmid.
DIAGNOSTICS¶
If the
pmid does not correspond to any metric supported by this PMDA,
pmdaDesc returns
PM_ERR_PMID.
CAVEAT¶
The PMDA must be using
PMDA_INTERFACE_2 or later, as specified in the
call to
pmdaDSO(3) or
pmdaDaemon(3).
SEE ALSO¶
PMAPI(3),
PMDA(3),
pmdaDaemon(3),
pmdaDSO(3) and
pmLookupDesc(3).