1PMNAMEINDOMARCHIVE(3)      Library Functions Manual      PMNAMEINDOMARCHIVE(3)
2
3
4

NAME

6       pmNameInDomArchive  - translate an instance identifier into an instance
7       name
8

C SYNOPSIS

10       #include <pcp/pmapi.h>
11
12       int pmNameInDomArchive(pmInDom indom, int inst, char **name);
13
14       cc ... -lpcp
15

DESCRIPTION

17       Provided that the current Performance Metrics  Application  Programming
18       Interface  (PMAPI) context is associated with an archive log, pmNameIn‐
19       DomArchive will scan the union of all the instance domain metadata  for
20       the  instance domain indom, locate the first instance with the internal
21       instance identifier  given  by  inst,  and  return  the  full  external
22       instance identification via name.
23
24       This routine is a specialized version of the more general PMAPI routine
25       pmNameInDom.
26
27       The value for the instance domain indom is typically extracted  from  a
28       pmDesc  structure, following a call to pmLookupDesc(3) for a particular
29       performance metric.
30
31       The space for the value of name will have been allocated in pmNameInDo‐
32       mArchive  with malloc(3), and it is the responsibility of the caller to
33       free(3) the space when it is no longer required.
34
35       pmNameInDomArchive returns zero on success.
36

SEE ALSO

38       PMAPI(3),    pmGetConfig(3),    pmGetInDomArchive(3),     pmLookupInDo‐
39       mArchive(3), pmNameInDom(3), pcp.conf(5) and pcp.env(5).
40

DIAGNOSTICS

42       PM_ERR_NOTARCHIVE
43              the current PMAPI context is not associated with an archive log
44
45       PM_ERR_INDOM_LOG
46              indom  is  not  a defined instance domain identifier for the ar‐
47              chive log
48
49       PM_ERR_INST_LOG
50              the instance identifier inst  is  not  known  for  the  instance
51              domain indom in the archive log
52
53
54
55Performance Co-Pilot                  PCP                PMNAMEINDOMARCHIVE(3)
Impressum