---
name: "PAPI_cleanup_eventset"
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_cleanup_eventset"
---

# PAPI\_cleanup\_eventset(3)

Empty and destroy an EventSet.

## NAME

PAPI\_cleanup\_eventset - Empty and destroy an EventSet.

## SYNOPSIS

## Detailed Description

**C Interface:**

\#include \<**papi.h**\> \
\
  int **PAPI\_cleanup\_eventset( int  EventSet )**;

**PAPI\_cleanup\_eventset** removes all events from a PAPI event set and turns off profiling and overflow for all events in the EventSet. This can not be called if the EventSet is not stopped.

**Parameters**

*EventSet* An integer handle for a PAPI event set as created by **PAPI\_create\_eventset**.

**Return values**

*PAPI\_EINVAL* One or more of the arguments is invalid. Attempting to destroy a non-empty event set or passing in a null pointer to be destroyed. \
 *PAPI\_ENOEVST* The EventSet specified does not exist. \
 *PAPI\_EISRUN* The EventSet is currently counting events. \
 *PAPI\_EBUG* Internal error, send mail to ptools-perfapi@icl.utk.edu and complain.

**Examples:**

```
// Remove all events in the eventset
if ( PAPI_cleanup_eventset( EventSet ) != PAPI_OK )
handle_error( 1 );
```

**See also**

**PAPI\_profil** \
\
  **PAPI\_create\_eventset** \
\
  **PAPI\_add\_event** \
\
  **PAPI\_stop**

## Author

Generated automatically by Doxygen for PAPI from the source code.