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

NAME

6       pmDelProfile  - delete instance(s) from the current PMAPI instance pro‐
7       file
8

C SYNOPSIS

10       #include <pcp/pmapi.h>
11
12       int pmDelProfile(pmInDom indom, int numinst, int *instlist);
13
14       cc ... -lpcp
15

DESCRIPTION

17       The set of instances for performance metrics returned from a pmFetch(3)
18       call may be filtered or restricted using an instance profile.  There is
19       one instance profile for each context the application  creates  at  the
20       Performance Metrics Application Programming Interface (PMAPI), and each
21       instance profile may  include  instances  from  one  or  more  instance
22       domains (see pmLookupDesc(3)).
23
24       pmDelProfile  may  be  used  to delete instance specifications from the
25       instance profile of the current PMAPI context.
26
27       In the simplest variant,  the  list  of  instances  identified  by  the
28       instlist  argument  for  the indom instance domain are removed from the
29       instance profile.  The list of instance  identifiers  contains  numinst
30       values.
31
32       The   indom   value   would  normally  be  extracted  from  a  call  to
33       pmLookupDesc(3) for a particular performance metric, and the  instances
34       in  instlist would typically be determined by calls to pmGetInDom(3) or
35       pmLookupInDom(3).
36
37       If indom equals PM_INDOM_NULL or numinst is  zero,  then  all  instance
38       domains  are  selected  for  deletion.   If  instlist is NULL, then all
39       instances in the selected domain(s) are removed from the profile.
40
41       To disable all  available  instances  in  all  domains,  use  pmDelPro‐
42       file(PM_INDOM_NULL,  0,  NULL).   This  is  the only situation in which
43       indom may be PM_INDOM_NULL.
44

SEE ALSO

46       pmAddProfile(3), PMAPI(3), pmFetch(3), pmGetInDom(3),  pmLookupDesc(3),
47       pmLookupInDom(3),   pmNewContext(3),  pmUseContext(3)  and  pmWhichCon‐
48       text(3).
49

DIAGNOSTICS

51       PM_ERR_PROFILESPEC
52              indom was PM_INDOM_NULL and instlist was not empty
53

CAVEAT

55       It is possible to delete non-existent instance domains and non-existent
56       instances  from an instance profile.  None of the routines that use the
57       instance profile will ever issue an error if you do this.  The cost  of
58       checking, when checking is possible, outweighs any benefits.
59
60
61
62Performance Co-Pilot                  PCP                      PMDELPROFILE(3)
Impressum