Blame man/man3/PAPI_get_event_info.3
Branch: 57771707c5d17696fd3660ed6f10428b3c234e9a
Packit
577717
.TH "PAPI_get_event_info" 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_get_event_info \-
Packit
577717
.PP
Packit
577717
Get the event's name and description info\&.
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
\fBParameters:\fP
Packit
577717
.RS 4
Packit
577717
\fIEventCode\fP event code (preset or native)
Packit
577717
.br
Packit
577717
\fIinfo\fP structure with the event information \fBPAPI_event_info_t\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\&.
Packit
577717
.br
Packit
577717
\fIPAPI_ENOTPRESET\fP The PAPI preset mask was set, but the hardware event specified is not a valid PAPI preset\&.
Packit
577717
.br
Packit
577717
\fIPAPI_ENOEVNT\fP The PAPI preset is not available on the underlying hardware\&.
Packit
577717
.RE
Packit
577717
.PP
Packit
577717
This function fills the event information into a structure\&. In Fortran, some fields of the structure are returned explicitly\&. This function works with existing PAPI preset and native event codes\&.
Packit
577717
.PP
Packit
577717
\fBSee Also:\fP
Packit
577717
.RS 4
Packit
577717
\fBPAPI_event_name_to_code\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\&.