File: PAPI_list_threads.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 (56 lines) | stat: -rw-r--r-- 1,299 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
.TH "PAPI_list_threads" 3 "Mon Jun 30 2014" "Version 5.3.2.0" "PAPI" \" -*- nroff -*-
.ad l
.nh
.SH NAME
PAPI_list_threads \- 
.PP
List the registered thread ids\&.  

.SH SYNOPSIS
.br
.PP
.SH "Detailed Description"
.PP 
\fBPAPI_list_threads()\fP returns to the caller a list of all thread IDs known to PAPI\&.
.PP
This call assumes an initialized PAPI library\&.
.PP
\fBC Interface\fP
.RS 4
#include <\fBpapi\&.h\fP> 
.br
int \fBPAPI_list_threads(PAPI_thread_id_t *tids, int * number )\fP;
.RE
.PP
\fBParameters:\fP
.RS 4
\fI*tids\fP -- A pointer to a preallocated array\&. This may be NULL to only return a count of threads\&. No more than *number codes will be stored in the array\&. 
.br
\fI*number\fP -- An input and output parameter\&. Input specifies the number of allocated elements in *tids (if non-NULL) and output specifies the number of threads\&.
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIPAPI_OK\fP The call returned successfully\&. 
.br
\fIPAPI_EINVAL\fP *number has an improper value
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBPAPI_get_thr_specific\fP 
.PP
\fBPAPI_set_thr_specific\fP 
.PP
\fBPAPI_register_thread\fP 
.PP
\fBPAPI_unregister_thread\fP 
.PP
\fBPAPI_thread_init\fP \fBPAPI_thread_id\fP 
.RE
.PP


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