Blame man/man3/PAPI_list_threads.3
Branch: 552d6d1af62cc0295a89fc10924aca25b9f08f2e
Packit Service
a1973e
.TH "PAPI_list_threads" 3 "Mon Dec 18 2017" "Version 5.6.0.0" "PAPI" \" -*- nroff -*-
Packit Service
a1973e
.ad l
Packit Service
a1973e
.nh
Packit Service
a1973e
.SH NAME
Packit Service
a1973e
PAPI_list_threads \-
Packit Service
a1973e
.PP
Packit Service
a1973e
List the registered thread ids\&.
Packit Service
a1973e
Packit Service
a1973e
.SH SYNOPSIS
Packit Service
a1973e
.br
Packit Service
a1973e
.PP
Packit Service
a1973e
.SH "Detailed Description"
Packit Service
a1973e
.PP
Packit Service
a1973e
\fBPAPI_list_threads()\fP returns to the caller a list of all thread IDs known to PAPI\&.
Packit Service
a1973e
.PP
Packit Service
a1973e
This call assumes an initialized PAPI library\&.
Packit Service
a1973e
.PP
Packit Service
a1973e
\fBC Interface\fP
Packit Service
a1973e
.RS 4
Packit Service
a1973e
#include <\fBpapi\&.h\fP>
Packit Service
a1973e
.br
Packit Service
a1973e
int \fBPAPI_list_threads(PAPI_thread_id_t *tids, int * number )\fP;
Packit Service
a1973e
.RE
Packit Service
a1973e
.PP
Packit Service
a1973e
\fBParameters:\fP
Packit Service
a1973e
.RS 4
Packit Service
a1973e
\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\&.
Packit Service
a1973e
.br
Packit Service
a1973e
\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\&.
Packit Service
a1973e
.RE
Packit Service
a1973e
.PP
Packit Service
a1973e
\fBReturn values:\fP
Packit Service
a1973e
.RS 4
Packit Service
a1973e
\fIPAPI_OK\fP The call returned successfully\&.
Packit Service
a1973e
.br
Packit Service
a1973e
\fIPAPI_EINVAL\fP *number has an improper value
Packit Service
a1973e
.RE
Packit Service
a1973e
.PP
Packit Service
a1973e
\fBSee Also:\fP
Packit Service
a1973e
.RS 4
Packit Service
a1973e
\fBPAPI_get_thr_specific\fP
Packit Service
a1973e
.PP
Packit Service
a1973e
\fBPAPI_set_thr_specific\fP
Packit Service
a1973e
.PP
Packit Service
a1973e
\fBPAPI_register_thread\fP
Packit Service
a1973e
.PP
Packit Service
a1973e
\fBPAPI_unregister_thread\fP
Packit Service
a1973e
.PP
Packit Service
a1973e
\fBPAPI_thread_init\fP \fBPAPI_thread_id\fP
Packit Service
a1973e
.RE
Packit Service
a1973e
.PP
Packit Service
a1973e
Packit Service
a1973e
Packit Service
a1973e
.SH "Author"
Packit Service
a1973e
.PP
Packit Service
a1973e
Generated automatically by Doxygen for PAPI from the source code\&.