1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
.TH "PAPI_event_name_to_code" 3 "Wed Jun 25 2025 19:30:48" "Version 7.2.0.0" "PAPI" \" -*- nroff -*-
.ad l
.nh
.SH NAME
PAPI_event_name_to_code \- Convert a name to a numeric hardware event code\&.
.SH SYNOPSIS
.br
.PP
.SH "Detailed Description"
.PP
.PP
\fBC Interface:\fP
.RS 4
#include <\fBpapi\&.h\fP>
.br
int PAPI_event_name_to_code( const char * EventName, int * EventCode );
.RE
.PP
\fBPAPI_event_name_to_code\fP is used to translate an ASCII PAPI event name into an integer PAPI event code\&.
.PP
\fBParameters\fP
.RS 4
\fI*EventCode\fP The numeric code for the event\&.
.br
\fI*EventName\fP A string containing the event name as listed in PAPI_presets or discussed in PAPI_native\&.
.RE
.PP
\fBReturn values\fP
.RS 4
\fIPAPI_EINVAL\fP One or more of the arguments is invalid\&.
.br
\fIPAPI_ENOTPRESET\fP The hardware event specified is not a valid PAPI preset\&.
.br
\fIPAPI_ENOINIT\fP The PAPI library has not been initialized\&.
.br
\fIPAPI_ENOEVNT\fP The hardware event is not available on the underlying hardware\&.
.RE
.PP
\fBExamples:\fP
.RS 4
.PP
.nf
int EventCode, EventSet = PAPI_NULL;
// Convert to integer
if ( PAPI_event_name_to_code( "PAPI_TOT_INS", &EventCode ) != PAPI_OK )
handle_error( 1 );
// Create the EventSet
if ( PAPI_create_eventset( &EventSet ) != PAPI_OK )
handle_error( 1 );
// Add Total Instructions Executed to our EventSet
if ( PAPI_add_event( EventSet, EventCode ) != PAPI_OK )
handle_error( 1 );
.fi
.PP
.RE
.PP
\fBSee also\fP
.RS 4
\fBPAPI_event_code_to_name\fP
.PP
\fBPAPI_remove_event\fP
.PP
\fBPAPI_get_event_info\fP
.PP
\fBPAPI_enum_event\fP
.PP
\fBPAPI_add_event\fP
.PP
\fBPAPI_add_named_event\fP
.PP
PAPI_presets
.PP
PAPI_native
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for PAPI from the source code\&.
|
