.TH "PAPI_start_counters" 3 "Mon Dec 18 2017" "Version 5.6.0.0" "PAPI" \" -*- nroff -*-

.ad l

.nh

.SH NAME

PAPI_start_counters \- 

.PP

Start counting hardware events\&.  

.SH SYNOPSIS

.br

.PP

.SH "Detailed Description"

.PP 

.PP

.nf

@par C Interface:

\#include <papi.h> @n

int PAPI_start_counters( int *events, int array_len );

.fi

.PP

.PP

\fBParameters:\fP

.RS 4

\fI*events\fP an array of codes for events such as PAPI_INT_INS or a native event code 

.br

\fIarray_len\fP the number of items in the *events array

.RE

.PP

\fBReturn values:\fP

.RS 4

\fIPAPI_EINVAL\fP One or more of the arguments is invalid\&. 

.br

\fIPAPI_EISRUN\fP Counters have already been started, you must call \fBPAPI_stop_counters()\fP before you call this function again\&. 

.br

\fIPAPI_ESYS\fP A system or C library call failed inside PAPI, see the errno variable\&. 

.br

\fIPAPI_ENOMEM\fP Insufficient memory to complete the operation\&. 

.br

\fIPAPI_ECNFLCT\fP The underlying counter hardware cannot count this event and other events in the EventSet simultaneously\&. 

.br

\fIPAPI_ENOEVNT\fP The PAPI preset is not available on the underlying hardware\&.

.RE

.PP

\fBPAPI_start_counters()\fP starts counting the events named in the *events array\&. This function cannot be called if the counters have already been started\&. The user must call \fBPAPI_stop_counters()\fP to stop the events explicitly if he/she wants to call this function again\&. It is the user's responsibility to choose events that can be counted simultaneously by reading the vendor's documentation\&. The length of the *events array should be no longer than the value returned by \fBPAPI_num_counters()\fP\&.

.PP

.PP

.nf

if( PAPI_start_counters( Events, num_hwcntrs ) != PAPI_OK )

    handle_error(1);

 *  

.fi

.PP

.PP

\fBSee Also:\fP

.RS 4

\fBPAPI_stop_counters()\fP \fBPAPI_add_event()\fP \fBPAPI_create_eventset()\fP 

.RE

.PP

.SH "Author"

.PP 

Generated automatically by Doxygen for PAPI from the source code\&.