pmlookuptext(3) [centos man page]

PMLOOKUPTEXT(3) 					     Library Functions Manual						   PMLOOKUPTEXT(3)

NAME

       pmLookupText - return text describing a performance metric

C SYNOPSIS

       #include <pcp/pmapi.h>

       int pmLookupText(pmID pmid, int level, char **buffer);

       cc ... -lpcp

DESCRIPTION

       Provided  the  source of metrics from the current Performance Metrics Application Programming Interface (PMAPI) context is a host, retrieve
       descriptive text about the performance metric identified by pmid.

       The argument level should be PM_TEXT_ONELINE for a one-line summary, else PM_TEXT_HELP for a more verbose description,  suited  to  a  help
       dialog.

       The  space  pointed  to	by  buffer will have been allocated in pmLookupText with malloc(3C), and it is the responsibility of the caller to
       free(3C) the space when it is no longer required.

       pmLookupText returns zero on success.

SEE ALSO

       chkhelp(1), newhelp(1), PMAPI(3), pmGetConfig(3), pmLookupDesc(3), pmLookupInDomText(3), pcp.conf(5) and pcp.env(5).

DIAGNOSTICS

       PM_ERR_NOTHOST
	      if the current PMAPI context is an archive log (help and one-line text is not maintained in the archive logs)

Performance Co-Pilot							PCP							   PMLOOKUPTEXT(3)

PMLOOKUPINDOMARCHIVE(3) 				     Library Functions Manual					   PMLOOKUPINDOMARCHIVE(3)

NAME

       pmLookupInDomArchive - translate an instance name into an instance identifier

C SYNOPSIS

       #include <pcp/pmapi.h>

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

       cc ... -lpcp

DESCRIPTION

       Provided the current Performance Metrics Application Programming Interface (PMAPI) context is associated with an archive log, pmLookupInDo-
       mArchive will scan the union of all the instance domain metadata for the instance domain indom, locate the first instance with the external
       identification given by name, and return the internal instance identifier.

       This routine is a specialized version of the more general PMAPI routine pmLookupInDom.

       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 particu-
       lar performance metric.

       pmLookupInDomArchive will return a positive instance identifier on success.

SEE ALSO

       PMAPI(3), pmGetConfig(3), pmGetInDomArchive(3), pmLookupDesc(3), pmLookupInDom(3), pmNameInDomArchive(3), pcp.conf(5) and pcp.env(5).

DIAGNOSTICS

       PM_ERR_NOTARCHIVE
	      the current PMAPI context is not associated with an archive log

       PM_ERR_INDOM_LOG
	      indom is not a defined instance domain identifier for the archive log

       PM_ERR_INST_LOG
	      the external instance name is not known for the instance domain indom in the archive log

Performance Co-Pilot							PCP						   PMLOOKUPINDOMARCHIVE(3)