PAPI  5.3.0.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
PAPI_disable_component Class Reference

disables the specified component More...

Detailed Description

@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:
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_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.

PAPI_disable_component() must be called before PAPI_library_init().

See Also
PAPI_get_event_component
PAPI_library_init

The documentation for this class was generated from the following file: