.TH "PAPI_disable_component" 3 "Mon Dec 18 2017" "Version 5.6.0.0" "PAPI" \" -*- nroff -*-

.ad l

.nh

.SH NAME

PAPI_disable_component \- 

.PP

disables the specified component  

.SH SYNOPSIS

.br

.PP

.SH "Detailed Description"

.PP 

.PP

.nf

@retval ENOCMP

    component does not exist

   @retval ENOINIT

           cannot disable as PAPI has already been initialized

@param cidx

           component index of component to be disabled

@par Examples:

.fi

.PP

.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

 \fBPAPI_disable_component()\fP allows the user to disable components before \fBPAPI_library_init()\fP 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\&.

.PP

\fBPAPI_disable_component()\fP must be called before \fBPAPI_library_init()\fP\&.

.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\&.