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
|
.TH "PAPI_query_named_event" 3 "Wed Jun 25 2025 19:30:48" "Version 7.2.0.0" "PAPI" \" -*- nroff -*-
.ad l
.nh
.SH NAME
PAPI_query_named_event \- Query if a named PAPI event exists\&.
.SH SYNOPSIS
.br
.PP
.SH "Detailed Description"
.PP
.PP
\fBC Interface:\fP
.RS 4
#include <\fBpapi\&.h\fP>
.br
int PAPI_query_named_event(const char *EventName);
.RE
.PP
PAPI_query_named_event() asks the PAPI library if the PAPI named event can be counted on this architecture\&. If the event CAN be counted, the function returns PAPI_OK\&. If the event CANNOT be counted, the function returns an error code\&. This function also can be used to check the syntax of native and user events\&.
.PP
\fBParameters\fP
.RS 4
\fIEventName\fP -- a defined event such as PAPI_TOT_INS\&.
.RE
.PP
\fBReturn values\fP
.RS 4
\fIPAPI_EINVAL\fP One or more of the arguments is invalid\&.
.br
\fIPAPI_ENOEVNT\fP The PAPI preset is not available on the underlying hardware\&.
.RE
.PP
\fBExamples\fP
.RS 4
.PP
.nf
int retval;
// Initialize the library
retval = PAPI_library_init(PAPI_VER_CURRENT);
if (retval != PAPI_VER_CURRENT) {
fprintf(stderr,\\"PAPI library init error!\\\\n\\");
exit(1);
}
if (PAPI_query_named_event("PAPI_TOT_INS") != PAPI_OK) {
fprintf(stderr,\\"No instruction counter? How lame\&.\\\\n\\");
exit(1);
}
.fi
.PP
.RE
.PP
\fBSee also\fP
.RS 4
\fBPAPI_query_event\fP
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for PAPI from the source code\&.
|