pmlookupindom

C Synopsis

#include <pcp/pmapi.h>

int pmLookupInDom(pmInDom indom, const char *name);

cc ... -lpcp

Description

For the instance domain indom, in the current Performance Metrics Application Programming Interface (PMAPI) context, locate the instance with the external identification given by name, and return the internal instance identifier.

Only the leading non-space characters of name will be used to identify the instance.

The value for the instance domain indom is typically extracted from a pmDesc structure, following a call to pmLookupDesc(3) for a particular performance metric.

pmLookupInDom will return a positive instance identifier on success.

See Also

PMAPI(3), pmGetConfig(3), pmGetInDom(3), pmLookupDesc(3), pmLookupInDomArchive(3), pmNameInDom(3), pcp.conf(5) and pcp.env(5).

Diagnostics

PM_ERR_INDOM

indom is not a valid instance domain identifier

PM_ERR_INST

The external instance name is not known for the instance domain indom in the current PMAPI context

Referenced By

LOGARCHIVE(5), PCPIntro(3), pmAddProfile(3), PMAPI(3), pmDelProfile(3), pmGetInDom(3), pmiAddInstance(3), pmLookupInDomArchive(3), pmNameInDom(3), pmseries(1), pmSetMode(3).

The man page pmlookupindom(3) is an alias of pmLookupInDom(3).