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

.ad l

.nh

.SH NAME

PAPI_state \- 

.PP

Return the counting state of an EventSet\&.  

.SH SYNOPSIS

.br

.PP

.SH "Detailed Description"

.PP 

.PP

\fBC Interface:\fP

.RS 4

#include <\fBpapi\&.h\fP> 

.br

 int \fBPAPI_state( int  EventSet, int * status )\fP;

.RE

.PP

\fBParameters:\fP

.RS 4

\fIEventSet\fP -- an integer handle for a PAPI event set as created by \fBPAPI_create_eventset\fP 

.br

\fIstatus\fP -- an integer containing a boolean combination of one or more of the following nonzero constants as defined in the PAPI header file \fBpapi\&.h\fP: 

.PD 0

.IP "\(bu" 2

PAPI_STOPPED -- EventSet is stopped 

.IP "\(bu" 2

PAPI_RUNNING -- EventSet is running 

.IP "\(bu" 2

PAPI_PAUSED -- EventSet temporarily disabled by the library 

.IP "\(bu" 2

PAPI_NOT_INIT -- EventSet defined, but not initialized 

.IP "\(bu" 2

PAPI_OVERFLOWING -- EventSet has overflowing enabled 

.IP "\(bu" 2

PAPI_PROFILING -- EventSet has profiling enabled 

.IP "\(bu" 2

PAPI_MULTIPLEXING -- EventSet has multiplexing enabled 

.IP "\(bu" 2

PAPI_ACCUMULATING -- reserved for future use 

.IP "\(bu" 2

PAPI_HWPROFILING -- reserved for future use  

.PP

.RE

.PP

\fBReturn values:\fP

.RS 4

\fIPAPI_OK\fP 

.br

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

.br

\fIPAPI_ENOEVST\fP The EventSet specified does not exist\&.  

.RE

.PP

\fBPAPI_state()\fP returns the counting state of the specified event set\&.  

.PP

\fBExample:\fP

.RS 4

.PP

.nf

*  int EventSet = PAPI_NULL;

*  int status = 0;

*  int ret;

*  

*  ret = PAPI_create_eventset(&EventSet);

*  if (ret != PAPI_OK) handle_error(ret);

*  

*  // Add Total Instructions Executed to our EventSet

*  ret = PAPI_add_event(EventSet, PAPI_TOT_INS);

*  if (ret != PAPI_OK) handle_error(ret);

*  

*  // Start counting

*  ret = PAPI_state(EventSet, &status);

*  if (ret != PAPI_OK) handle_error(ret);

*  printf("State is now %d\n",status);

*  ret = PAPI_start(EventSet);

*  if (ret != PAPI_OK) handle_error(ret);

*  ret = PAPI_state(EventSet, &status);

*  if (ret != PAPI_OK) handle_error(ret);

*  printf("State is now %d\n",status);

*  

.fi

.PP

.RE

.PP

\fBSee Also:\fP

.RS 4

\fBPAPI_stop\fP \fBPAPI_start\fP 

.RE

.PP

.SH "Author"

.PP 

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