|
Packit |
577717 |
.TH "PAPI_list_events" 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_list_events \-
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
list the events 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 |
List the events in an event set\&.
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
.nf
|
|
Packit |
577717 |
PAPI_list_events() returns an array of events and a count of the
|
|
Packit |
577717 |
.fi
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
total number of events in an event set\&. This call assumes an initialized PAPI library and a successfully created event set\&.
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBC Interface\fP
|
|
Packit |
577717 |
.RS 4
|
|
Packit |
577717 |
#include <\fBpapi\&.h\fP>
|
|
Packit |
577717 |
.br
|
|
Packit |
577717 |
int \fBPAPI_list_events(int *EventSet, int *Events, int *number )\fP;
|
|
Packit |
577717 |
.RE
|
|
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 |
.br
|
|
Packit |
577717 |
\fI*Events\fP A pointer to a preallocated array of codes for events, such as PAPI_INT_INS\&. No more than *number codes will be stored into the array\&.
|
|
Packit |
577717 |
.br
|
|
Packit |
577717 |
\fI*number\fP On input, the size of the Events array, or maximum number of event codes to be returned\&. A value of 0 can be used to probe an event set\&. On output, the number of events actually in the event set\&. This value may be greater than the actually stored number of event codes\&.
|
|
Packit |
577717 |
.RE
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBReturn values:\fP
|
|
Packit |
577717 |
.RS 4
|
|
Packit |
577717 |
\fIPAPI_EINVAL\fP
|
|
Packit |
577717 |
.br
|
|
Packit |
577717 |
\fIPAPI_ENOEVST\fP
|
|
Packit |
577717 |
.RE
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBExamples:\fP
|
|
Packit |
577717 |
.RS 4
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
.nf
|
|
Packit |
577717 |
if (PAPI_event_name_to_code("PAPI_TOT_INS",&EventCode) != PAPI_OK)
|
|
Packit |
577717 |
exit(1);
|
|
Packit |
577717 |
if (PAPI_add_event(EventSet, EventCode) != PAPI_OK)
|
|
Packit |
577717 |
exit(1);
|
|
Packit |
577717 |
Convert a second event name to an event code
|
|
Packit |
577717 |
if (PAPI_event_name_to_code("PAPI_L1_LDM",&EventCode) != PAPI_OK)
|
|
Packit |
577717 |
exit(1);
|
|
Packit |
577717 |
if (PAPI_add_event(EventSet, EventCode) != PAPI_OK)
|
|
Packit |
577717 |
exit(1);
|
|
Packit |
577717 |
number = 0;
|
|
Packit |
577717 |
if(PAPI_list_events(EventSet, NULL, &number))
|
|
Packit |
577717 |
exit(1);
|
|
Packit |
577717 |
if(number != 2)
|
|
Packit |
577717 |
exit(1);
|
|
Packit |
577717 |
if(PAPI_list_events(EventSet, Events, &number))
|
|
Packit |
577717 |
exit(1);
|
|
Packit |
577717 |
*
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.fi
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.RE
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBSee Also:\fP
|
|
Packit |
577717 |
.RS 4
|
|
Packit |
577717 |
\fBPAPI_event_code_to_name\fP
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBPAPI_event_name_to_code\fP
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBPAPI_add_event\fP
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBPAPI_create_eventset\fP
|
|
Packit |
577717 |
.RE
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBFortran Interface:\fP
|
|
Packit |
577717 |
.RS 4
|
|
Packit |
577717 |
#include 'fpapi\&.h'
|
|
Packit |
577717 |
.br
|
|
Packit |
577717 |
\fBPAPI_list_events\fP( C_INT EventSet, C_INT(*) Events, C_INT number, C_INT check )
|
|
Packit |
577717 |
.RE
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBSee Also:\fP
|
|
Packit |
577717 |
.RS 4
|
|
Packit |
577717 |
\fBPAPI_list_events\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\&.
|