Blame man/man3/PAPI_reset.3

Packit 577717
.TH "PAPI_reset" 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_reset \- 
Packit 577717
.PP
Packit 577717
Reset the hardware event counts in an event set\&.  
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 Prototype:
Packit 577717
    \#include <papi.h> @n
Packit 577717
    int PAPI_reset( int EventSet );
Packit 577717
Packit 577717
@param EventSet
Packit 577717
    an integer handle for a PAPI event set as created by PAPI_create_eventset 
Packit 577717
Packit 577717
@retval PAPI_OK 
Packit 577717
@retval PAPI_ESYS 
Packit 577717
    A system or C library call failed inside PAPI, see the errno variable.
Packit 577717
@retval PAPI_ENOEVST 
Packit 577717
    The EventSet specified does not exist. 
Packit 577717
Packit 577717
Packit 577717
Packit 577717
PAPI_reset() zeroes the values of the counters contained in EventSet. 
Packit 577717
This call assumes an initialized PAPI library and a properly added event set 
Packit 577717
Packit 577717
@par Example:
Packit 577717
Packit 577717
.fi
Packit 577717
.PP
Packit 577717
 
Packit 577717
.PP
Packit 577717
.nf
Packit 577717
int EventSet = PAPI_NULL;
Packit 577717
int Events[] = {PAPI_TOT_INS, PAPI_FP_OPS};
Packit 577717
int ret;
Packit 577717
 
Packit 577717
// Create an empty EventSet
Packit 577717
ret = PAPI_create_eventset(&EventSet);
Packit 577717
if (ret != PAPI_OK) handle_error(ret);
Packit 577717
Packit 577717
// Add two events to our EventSet
Packit 577717
ret = PAPI_add_events(EventSet, Events, 2);
Packit 577717
if (ret != PAPI_OK) handle_error(ret);
Packit 577717
Packit 577717
// Start counting
Packit 577717
ret = PAPI_start(EventSet);
Packit 577717
if (ret != PAPI_OK) handle_error(ret);
Packit 577717
Packit 577717
// Stop counting, ignore values
Packit 577717
ret = PAPI_stop(EventSet, NULL);
Packit 577717
if (ret != PAPI_OK) handle_error(ret);
Packit 577717
Packit 577717
// reset the counters in this EventSet
Packit 577717
ret = PAPI_reset(EventSet);
Packit 577717
if (ret != PAPI_OK) handle_error(ret);
Packit 577717
 *  
Packit 577717
Packit 577717
.fi
Packit 577717
.PP
Packit 577717
.PP
Packit 577717
\fBSee Also:\fP
Packit 577717
.RS 4
Packit 577717
\fBPAPI_create_eventset\fP 
Packit 577717
.RE
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\&.