File: PAPI_destroy_eventset.3

package info (click to toggle)
papi 5.3.2-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 27,244 kB
  • ctags: 37,740
  • sloc: ansic: 384,780; makefile: 3,319; fortran: 3,306; xml: 2,460; sh: 791; python: 515; perl: 269; asm: 24
file content (67 lines) | stat: -rw-r--r-- 1,441 bytes parent folder | download
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
.TH "PAPI_destroy_eventset" 3 "Mon Jun 30 2014" "Version 5.3.2.0" "PAPI" \" -*- nroff -*-
.ad l
.nh
.SH NAME
PAPI_destroy_eventset \- 
.PP
Empty and destroy an EventSet\&.  

.SH SYNOPSIS
.br
.PP
.SH "Detailed Description"
.PP 

.PP
.nf
@par C Interface:
\#include <papi.h> @n
int PAPI_destroy_eventset( int * EventSet );

.fi
.PP
.PP
\fBPAPI_destroy_eventset\fP deallocates the memory associated with an empty PAPI EventSet\&.
.PP
\fBParameters:\fP
.RS 4
\fI*EventSet\fP A pointer to the integer handle for a PAPI event set as created by \fBPAPI_create_eventset\fP\&. The value pointed to by EventSet is then set to PAPI_NULL on success\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIPAPI_EINVAL\fP One or more of the arguments is invalid\&. Attempting to destroy a non-empty event set or passing in a null pointer to be destroyed\&. 
.br
\fIPAPI_ENOEVST\fP The EventSet specified does not exist\&. 
.br
\fIPAPI_EISRUN\fP The EventSet is currently counting events\&. 
.br
\fIPAPI_EBUG\fP Internal error, send mail to ptools-perfapi@ptools.org and complain\&.
.RE
.PP
\fBExamples:\fP
.RS 4

.PP
.nf
*   // Free all memory and data structures, EventSet must be empty\&.
*   if ( PAPI_destroy_eventset( &EventSet ) != PAPI_OK )
*   handle_error( 1 );
*   

.fi
.PP
.RE
.PP
.PP
.nf
@see PAPI_profil @n
PAPI_create_eventset @n
PAPI_add_event @n
PAPI_stop.fi
.PP
 

.SH "Author"
.PP 
Generated automatically by Doxygen for PAPI from the source code\&.