summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_getthreadprivate.rst
blob: 7303eae93b60362be782e410cfb0b2286ba710df (plain)
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
PR_GetThreadPrivate
===================

Recovers the per-thread private data for the current thread.


Syntax
------

.. code::

   #include <prthread.h>

   void* PR_GetThreadPrivate(PRUintn index);


Parameter
~~~~~~~~~

:ref:`PR_GetThreadPrivate` has the following parameters:

``index``
   The index into the per-thread private data table.


Returns
~~~~~~~

``NULL`` if the data has not been set.


Description
-----------

:ref:`PR_GetThreadPrivate` may be called at any time during a thread's
execution. A thread can get access only to its own per-thread private
data. Do not delete the object that the private data refers to without
first clearing the thread's value.