---
name: "PAPI_list_events"
section: "3"
platform: "linux"
package: "libpapi-dev"
version: "7.1.0-5+b1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/PAPI_list_events"
---

# PAPI\_list\_events(3)

list the events in an event set

## NAME

PAPI\_list\_events - list the events in an event set

## SYNOPSIS

## Detailed Description

List the events in an event set.

**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.

**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 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**

*PAPI\_EINVAL* \
 *PAPI\_ENOEVST*

**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 = 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.