Blame man/man3/PAPI_cleanup_eventset.3
Branch: 57771707c5d17696fd3660ed6f10428b3c234e9a
Packit
577717
.TH "PAPI_cleanup_eventset" 3 "Mon Dec 18 2017" "Version 5.6.0.0" "PAPI" \" -*- nroff -*-
Packit
577717
.ad l
Packit
577717
.nh
Packit
577717
.SH NAME
Packit
577717
PAPI_cleanup_eventset \-
Packit
577717
.PP
Packit
577717
Empty and destroy an EventSet\&.
Packit
577717
Packit
577717
.SH SYNOPSIS
Packit
577717
.br
Packit
577717
.PP
Packit
577717
.SH "Detailed Description"
Packit
577717
.PP
Packit
577717
Packit
577717
.PP
Packit
577717
.nf
Packit
577717
@par C Interface:
Packit
577717
\#include <papi.h> @n
Packit
577717
int PAPI_cleanup_eventset( int EventSet );
Packit
577717
Packit
577717
.fi
Packit
577717
.PP
Packit
577717
.PP
Packit
577717
\fBPAPI_cleanup_eventset\fP 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\&.
Packit
577717
.PP
Packit
577717
\fBParameters:\fP
Packit
577717
.RS 4
Packit
577717
\fIEventSet\fP An integer handle for a PAPI event set as created by \fBPAPI_create_eventset\fP\&.
Packit
577717
.RE
Packit
577717
.PP
Packit
577717
\fBReturn values:\fP
Packit
577717
.RS 4
Packit
577717
\fIPAPI_EINVAL\fP 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\&.
Packit
577717
.br
Packit
577717
\fIPAPI_ENOEVST\fP The EventSet specified does not exist\&.
Packit
577717
.br
Packit
577717
\fIPAPI_EISRUN\fP The EventSet is currently counting events\&.
Packit
577717
.br
Packit
577717
\fIPAPI_EBUG\fP Internal error, send mail to ptools-perfapi@icl.utk.edu and complain\&.
Packit
577717
.RE
Packit
577717
.PP
Packit
577717
\fBExamples:\fP
Packit
577717
.RS 4
Packit
577717
Packit
577717
.PP
Packit
577717
.nf
Packit
577717
* // Remove all events in the eventset
Packit
577717
* if ( PAPI_cleanup_eventset( EventSet ) != PAPI_OK )
Packit
577717
* handle_error( 1 );
Packit
577717
*
Packit
577717
Packit
577717
.fi
Packit
577717
.PP
Packit
577717
.RE
Packit
577717
.PP
Packit
577717
.PP
Packit
577717
.nf
Packit
577717
@see PAPI_profil @n
Packit
577717
PAPI_create_eventset @n
Packit
577717
PAPI_add_event @n
Packit
577717
PAPI_stop.fi
Packit
577717
.PP
Packit
577717
Packit
577717
Packit
577717
.SH "Author"
Packit
577717
.PP
Packit
577717
Generated automatically by Doxygen for PAPI from the source code\&.