File: PAPI_disable_component.3

package info (click to toggle)
papi 7.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 31,272 kB
  • sloc: ansic: 485,669; cpp: 7,483; fortran: 3,138; makefile: 2,501; xml: 2,460; f90: 1,374; python: 1,062; sh: 780; perl: 242; pascal: 167; asm: 5
file content (61 lines) | stat: -rw-r--r-- 1,236 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
.TH "PAPI_disable_component" 3 "Wed Jun 25 2025 19:30:48" "Version 7.2.0.0" "PAPI" \" -*- nroff -*-
.ad l
.nh
.SH NAME
PAPI_disable_component \- disables the specified component  

.SH SYNOPSIS
.br
.PP
.SH "Detailed Description"
.PP 

.PP
\fBReturn values\fP
.RS 4
\fIENOCMP\fP component does not exist 
.br
\fIENOINIT\fP cannot disable as PAPI has already been initialized
.RE
.PP
\fBParameters\fP
.RS 4
\fIcidx\fP component index of component to be disabled 
.RE
.PP
\fBExamples:\fP
.RS 4

.PP
.nf
int cidx, result;

cidx = PAPI_get_component_index("example");

if (cidx>=0) {
   result = PAPI_disable_component(cidx);
   if (result==PAPI_OK)
      printf("The example component is disabled\\n");
}
// \&.\&.\&. 
PAPI_library_init();

.fi
.PP
 PAPI_disable_component() allows the user to disable components before PAPI_library_init() time\&. This is useful if the user knows they do not wish to use events from that component and want to reduce the PAPI library overhead\&.
.RE
.PP
PAPI_disable_component() must be called before PAPI_library_init()\&.
.PP
\fBSee also\fP
.RS 4
\fBPAPI_get_event_component\fP 
.PP
\fBPAPI_library_init\fP 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for PAPI from the source code\&.