PAPI_write(3)

1PAPI_write(3)                        PAPI                        PAPI_write(3)
2
3
4

NAME

6       PAPI_write - Write counter values into counters
7
8

SYNOPSIS

10       C Interface
11       #include <papi.h>
12       int PAPI_write(int EventSet, long_long *values);
13       Fortran Interface
14       #include fpapi.h
15       PAPIF_write(C_INT EventSet, C_LONG_LONG(*) values, C_INT check)
16
17

DESCRIPTION

19       PAPI_write()  writes  the  counter  values provided in the array values
20       into the event set EventSet.  The virtual counters managed by the  PAPI
21       library  will  be  set to the values provided. If the event set is run‐
22       ning, an attempt will be made to write the values to the running  coun‐
23       ters.  This operation is not permitted by all substrates and may result
24       in a run-time error.
25
26

ARGUMENTS

28       EventSet --  an integer handle for a  PAPI  event  set  as  created  by
29       PAPI_create_eventset(3)
30
31       *values -- an array to hold the counter values of the counting events
32
33

RETURN VALUES

35       On success, this function returns PAPI_OK.
36        On error, a non-zero error code is returned.
37
38

ERRORS

40       PAPI_ENOEVST
41              The EventSet specified does not exist.
42
43       PAPI_ESBSTR
44              PAPI_write()   is   not   implemented   for  this  architecture.
45              PAPI_ESYS The EventSet is currently counting events and the sub‐
46              strate could not change the values of the running counters.
47
48

EXAMPLES

50       /* Yet to be written */
51
52
53

BUGS

55       This function has no known bugs.
56
57