Blame man/man3/PAPI_disable_component_by_name.3
Branch: 57771707c5d17696fd3660ed6f10428b3c234e9a
Packit
577717
.TH "PAPI_disable_component_by_name" 3 "Mon Dec 18 2017" "Version 5.6.0.0" "PAPI" \" -*- nroff -*-
Packit
577717
.ad l
Packit
577717
.nh
Packit
577717
.SH NAME
Packit
577717
PAPI_disable_component_by_name \-
Packit
577717
.PP
Packit
577717
disables the named component
Packit
577717
Packit
577717
.SH SYNOPSIS
Packit
577717
.br
Packit
577717
.PP
Packit
577717
.SH "Detailed Description"
Packit
577717
.PP
Packit
577717
Packit
577717
.PP
Packit
577717
.nf
Packit
577717
\retval ENOCMP
Packit
577717
component does not exist
Packit
577717
\retval ENOINIT
Packit
577717
unable to disable the component, the library has already been initialized
Packit
577717
\param component_name
Packit
577717
name of the component to disable.
Packit
577717
\par Example:
Packit
577717
Packit
577717
.fi
Packit
577717
.PP
Packit
577717
Packit
577717
.PP
Packit
577717
.nf
Packit
577717
int result;
Packit
577717
result = PAPI_disable_component_by_name("example");
Packit
577717
if (result==PAPI_OK)
Packit
577717
printf("component \"example\" has been disabled\n");
Packit
577717
//\&.\&.\&.
Packit
577717
PAPI_library_init(PAPI_VER_CURRENT);
Packit
577717
*
Packit
577717
Packit
577717
.fi
Packit
577717
.PP
Packit
577717
\fBPAPI_disable_component_by_name()\fP allows the user to disable a component before \fBPAPI_library_init()\fP time\&. This is useful if the user knows they do not with to use events from that component and want to reduce the PAPI library overhead\&.
Packit
577717
.PP
Packit
577717
\fBPAPI_disable_component_by_name()\fP must be called before \fBPAPI_library_init()\fP\&.
Packit
577717
.PP
Packit
577717
\fBSee Also:\fP
Packit
577717
.RS 4
Packit
577717
\fBPAPI_library_init\fP
Packit
577717
.PP
Packit
577717
\fBPAPI_disable_component\fP
Packit
577717
.RE
Packit
577717
.PP
Packit
577717
Packit
577717
Packit
577717
.SH "Author"
Packit
577717
.PP
Packit
577717
Generated automatically by Doxygen for PAPI from the source code\&.