Convert a numeric hardware event code to a name. More...

Detailed Description

C Interface:: #include <papi.h>
int PAPI_event_code_to_name( int EventCode, char * EventName );

PAPI_event_code_to_name is used to translate a 32-bit integer PAPI event code into an ASCII PAPI event name. Either Preset event codes or Native event codes can be passed to this routine. Native event codes and names differ from platform to platform.

Parameters:

EventCode	The numeric code for the event.
*EventName	A string containing the event name as listed in PAPI_presets or discussed in PAPI_native.

Return values:

PAPI_EINVAL	One or more of the arguments is invalid.
PAPI_ENOTPRESET	The hardware event specified is not a valid PAPI preset.
PAPI_ENOEVNT	The hardware event is not available on the underlying hardware.

Examples:

    int EventCode, EventSet = PAPI_NULL;
    char EventCodeStr[PAPI_MAX_STR_LEN];
    char EventDescr[PAPI_MAX_STR_LEN];
    char EventLabel[20];
    // Convert to integer
    if ( PAPI_event_name_to_code( "PAPI_TOT_INS", &EventCode ) != PAPI_OK )
    handle_error( 1 );
    // Create the EventSet
    if ( PAPI_create_eventset( &EventSet ) != PAPI_OK )
    handle_error( 1 );
    // Add Total Instructions Executed to our EventSet
    if ( PAPI_add_event( EventSet, EventCode ) != PAPI_OK )
    handle_error( 1 );

Bug:: No known bugs.

See also:: PAPI_remove_event; PAPI_get_event_info; PAPI_enum_event; PAPI_add_event; PAPI_presets; PAPI_native

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

papi.c