NAME

PAPI_get_event_info - get the event’s name and description info

CONTENTS

Synopsis
Description
Arguments
Return Values
Errors
Example
Authors
Bugs
See Also

C Interface

#include <papi.h> 

int PAPI_get_event_info(int EventCode, PAPI_event_info_t *info); 

Fortran Interface

#include fpapi.h 

PAPIF_get_event_info(C_INT EventCode, C_STRING symbol, 

        C_STRING long_descr, C_STRING C_INT count, 

        C_STRING event_note, C_INT , C_INT check) 

In C, this function fills the event information into a structure. In Fortran, some fields of the structure are returned explicitly.

The following arguments are implicit in the structure returned by the C function, or explicitly returned by Fortran.

EventCode -- event code(preset or native)

info -- structure with the event information

symbol -- whether the preset is part of the API

long_descr -- detail description about the event

short_descr -- short description about the event

event_note -- notes about the event

On success, the C function returns PAPI_OK, and the Fortran function returns PAPI_OK.
On error, a non-zero error code is returned by the function.

PAPI_EINVAL
	One or more of the arguments is invalid.
PAPI_ENOTPRESET
	The hardware event specified is not a valid PAPI preset.
PAPI_ENOEVNT
	The PAPI preset is not available on the underlying hardware.

int EventCode;
PAPI_event_info_t info;

if (PAPI_library_init(PAPI_VER_CURRENT) != PAPI_VER_CURRENT)
  exit(1);

if (PAPI_event_name_to_code("PAPI_TOT_INS",&EventCode) != PAPI_OK)
  handle_error(1);
        
if (PAPI_get_event_info(EventCode, &info) == PAPI_OK)
  handle_error(1);

The PAPI Team. See them at the PAPI Web Site: http://icl.cs.utk.edu/projects/papi

This function has no known bugs.

PAPI_library_init (3), PAPI_get_hardware_info (3), PAPI_get_opt (3)