NAME

       pmNameID - translate a PMID to a performance metric name


C SYNOPSIS

       #include <pcp/pmapi.h>

       int pmNameID(pmID pmid, char **name)

       cc ... -lpcp


DESCRIPTION

       Given  a  Performance  Metric ID (PMID) via pmid, pmNameID
       will determine the corresponding metric name, if  any,  in
       the Performance Metrics Name Space (PMNS), and return this
       via name.

       If the PMNS contains multiple names  associated  with  the
       requested  PMID,  one  of these will be returned via name,
       but there is no way to determine which  of  the  duplicate
       names this will be.  See pmNameAll(3) if all of the corre­
       sponding names are required.

       name  is  a  null-byte  terminated  string,  allocated  by
       pmNameID using malloc(3C) and it is the caller's responsi­
       bility to call free(3C) to release the  storage  when  the
       value is no longer required.

       In the absence of errors, pmNameID returns zero.


SEE ALSO

       PMAPI(3), pmGetChildren(3), pmGetChildrenStatus(3), pmGet­
       Config(3),  pmLoadASCIINameSpace(3),   pmLoadNameSpace(3),
       pmLookupName(3),       pmNameAll(3),      pmNewContext(3),
       pcp.conf(4), pcp.env(4) and pmns(4).


DIAGNOSTICS

       PM_ERR_NOPMNS
              Failed to access a PMNS for operation.   Note  that
              if  the  application hasn't a priori called pmLoad­
              NameSpace(3) and wants to use the distributed PMNS,
              then a call to pmNameId must be made after the cre­
              ation of a context (see pmNewContext(3)).

       PM_ERR_PMID
              pmid does not correspond to a defined PMID  in  the
              PMNS.

       PM_ERR_*
              Other  diagnostics  are  for protocol failures when
              accessing the distributed PMNS.


Man(1) output converted with man2html