PAPI  5.0.1.0
PAPI_list_events Class Reference

list the events in an event set More...


Detailed Description

List the events in an event set.

Parameters:
EventSetAn integer handle for a PAPI event set as created by PAPI_create_eventset
*EventsAn array of codes for events, such as PAPI_INT_INS. No more than *number codes will be stored into the array.
*numberOn input the variable determines the size of the Events array. On output the variable contains the number of counters in the event set. Note that if the given array Events is too short to hold all the counters in the event set the *number variable will be greater than the actually stored number of counter codes.
Return values:
PAPI_EINVAL
PAPI_ENOEVST* PAPIF_list_events(C_INT EventSet, C_INT(*) Events, C_INT number, C_INT check ) PAPI_list_events() decomposes an event set into the hardware events it contains. This call assumes an initialized PAPI library and a successfully added event set.
Examples:
        if (PAPI_event_name_to_code("PAPI_TOT_INS",&EventCode) != PAPI_OK)
        exit(1);
        if (PAPI_add_event(EventSet, EventCode) != PAPI_OK)
        exit(1);
        Convert a second event name to an event code 
        if (PAPI_event_name_to_code("PAPI_L1_LDM",&EventCode) != PAPI_OK)
        exit(1);
        if (PAPI_add_event(EventSet, EventCode) != PAPI_OK)
        exit(1);
        number = 4;
        if(PAPI_list_events(EventSet, Events, &number))
        exit(1);
        if(number != 2)
        exit(1);
See also:
PAPI_event_code_to_name
PAPI_event_name_to_code
PAPI_add_event PAPI_create_eventset
Fortran Interface:
#include "fpapi.h"
PAPI_list_events( C_INT EventSet, C_INT(*) Events, C_INT number, C_INT check )
See also:
PAPI_list_events

The documentation for this class was generated from the following file:
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines