PAPI_list_events(3)

💖 NAME 💖

Okay bestie, we're in the PAPI manual, and this specific page is PAPI_list_events(3). Its whole job? List the events in an event set. Periodt. 💅

✨ SYNOPSIS ✨

🌸 Detailed Description 🌸

PAPI_list_events() returns an array of events and a count of the total number of events in an event set. This call assumes an initialized PAPI library and a successfully created event set. No cap.

💅 C Interface 💅

#include <papi.h>
int PAPI_list_events(int EventSet, int *Events, int *number);

🎀 Parameters 🎀

• EventSet — an integer handle for a PAPI event set as created by PAPI_create_eventset.
• *Events — a pointer to a preallocated array of codes for events, such as PAPI_INT_INS. No more than *number codes will be stored into the array.
• *number — on input, the size of the Events array, or the maximum number of event codes to be returned. A value of 0 can be used to probe an event set. On output, the number of events actually in the event set. This value may be greater than the actually stored number of event codes.

🔥 Return values 🔥

The page literally just drops these two names, so here they are in their full iconic glory:

• PAPI_EINVAL
• PAPI_ENOEVST

🦋 Examples 🦋

Here's the example, kept exactly as the page has it:

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 = 0;
if(PAPI_list_events(EventSet, NULL, &number))
exit(1);
if(number != 2)
exit(1);
if(PAPI_list_events(EventSet, Events, &number))
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

⭐ Author ⭐

Generated automatically by Doxygen for PAPI from the source code.

---

That's the whole vibe, bestie: generated automatically by Doxygen for PAPI from the source code, version 7.2.0.0, dated Wed Jun 25 2025 19:30:48. Slay and byeee 🫶✨