PAPI_cleanup_eventset(3)

🌸 NAME 🌸

okay so this is PAPI_cleanup_eventset(3) from the PAPI manual, and the whole NAME vibe is PAPI_cleanup_eventset - Empty and destroy an EventSet πŸ’…. Like, clean it out, shut it down, bye bestie.

✨ SYNOPSIS ✨

πŸ’» C Interface πŸ’»

C Interface, no cap:

#include <papi.h>
int  PAPI_cleanup_eventset( int  EventSet );

🧚 Detailed Description 🧚

PAPI_cleanup_eventset removes all events from a PAPI event set and turns off profiling and overflow for all events in the EventSet. So it’s giving full reset energy ✨.

bestie, this can not be called if the EventSet is not stopped. Like, the EventSet has to be stopped first β€” periodt. 😭

πŸŽ€ 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. Also: 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. Not me being dramatic, that’s literally the instruction. 😭

πŸ’– Examples πŸ’–

okay so the example is literally this:

// 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. So yeah, Doxygen wrote this one β€” iconic automated behavior, honestly. πŸ€–βœ¨


byeee bestie 🫢 Version 7.2.0.0, dated Wed Jun 25 2025 19:30:48, and this whole thing is literally the PAPI_cleanup_eventset(3) page. periodt πŸ’…πŸŒˆ