1PAPI_list_threads(3)                 PAPI                 PAPI_list_threads(3)
2
3
4

NAME

6       PAPI_list_threads - list the registered thread ids
7

SYNOPSIS

9       C Interface
10
11       #include <papi.h>
12       int PAPI_list_threads(PAPI_thread_id_t *id, int *number);
13
14       Fortran Interface
15
16       <none>
17
18

DESCRIPTION

20       PAPI_list_threads()  returns  to  the  caller a list of all thread ID's
21       known to PAPI.
22
23       This call assumes an initialized PAPI library.
24
25

ARGUMENTS

27       *id -- A pointer to a preallocated array. This  may  be  NULL  to  only
28       return a count of threads. No more than *number codes will be stored in
29       the array.
30
31       *number -- An input and output parameter, input specifies the number of
32       allocated elements in *id (if non-NULL) and output specifies the number
33       of threads.
34

RETURN VALUES

36       PAPI_OK
37              The call returned successfully.
38
39       PAPI_EINVAL
40              One or more of the arguments is invalid.
41
42

EXAMPLES

44       /* Reserved for example usage */
45
46

BUGS

48       This function has no known bugs.
49
50

SEE ALSO

52       PAPI_thread_init(3),    PAPI_thread_id(3),     PAPI_register_thread(3),
53       PAPI_unregister_thread(3),  PAPI_get_thr_specific(3), PAPI_set_thr_spe‐
54       cific(3), PAPI(3)
55
56
57
58PAPI Programmer's Reference      October, 2006            PAPI_list_threads(3)