PAPI_list_threads

Langue: en

Version: October, 2006 (fedora - 01/12/10)

Section: 3 (Bibliothèques de fonctions)

NAME

PAPI_list_threads - list the registered thread ids

SYNOPSIS

C Interface

 #include <papi.h>
 int PAPI_list_threads(PAPI_thread_id_t *id, int *number);
 

Fortran Interface

 <none>
 

DESCRIPTION

PAPI_list_threads() returns to the caller a list of all thread ID's known to PAPI.

This call assumes an initialized PAPI library.

ARGUMENTS

*id -- 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.

*number -- An input and output parameter, input specifies the number of allocated elements in *id (if non-NULL) and output specifies the number of threads.

RETURN VALUES

PAPI_OK
The call returned successfully.
PAPI_EINVAL
One or more of the arguments is invalid.

EXAMPLES

 /* Reserved for example usage */
 

BUGS

This function has no known bugs.

SEE ALSO

PAPI_thread_init(3), PAPI_thread_id(3), PAPI_register_thread(3), PAPI_unregister_thread(3), PAPI_get_thr_specific(3), PAPI_set_thr_specific(3), PAPI(3)