NAME¶

PAPI_enum_event - Enumerate PAPI preset or native events.

SYNOPSIS¶

Detailed Description¶

@par C Interface:

int PAPI_enum_event( int * EventCode, int  modifer );

Given a preset or native event code, PAPI_enum_event replaces the event 
code with the next available event in either the preset or native table. 
The modifier argument affects which events are returned. 
For all platforms and event types, a value of PAPI_ENUM_ALL (zero) 
directs the function to return all possible events. @n

For preset events, a TRUE (non-zero) value currently directs the function 
to return event codes only for PAPI preset events available on this platform. 
This may change in the future. 
For native events, the effect of the modifier argument is different on each platform. 
See the discussion below for platform-specific definitions.

@param *EventCode
    A defined preset or native event such as PAPI_TOT_INS.
@param modifier 
    Modifies the search logic. See below for full list.
    For native events, each platform behaves differently. 
    See platform-specific documentation for details.

@retval PAPI_ENOEVNT 
    The next requested PAPI preset or native event is not available on 
    the underlying hardware.

@par Examples:

*   // Scan for all supported native events on this platform
*   printf( "Name       Code   Description0 );
*   do {
*       retval = PAPI_get_event_info( i, &info );
*       if ( retval == PAPI_OK ) {
*       printf( "%-30s %#-10x0s0, info.symbol, info.event_code, info.long_descr );
*       }
*   } while ( PAPI_enum_event( &i, PAPI_ENUM_ALL ) == PAPI_OK );
*   

Generic Modifiers Native Modifiers Preset Modifiers ITANIUM Modifiers POWER Modifiers See Also:

Author¶

Generated automatically by Doxygen for PAPI from the source code.