summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_jointhreadpool.rst
blob: 86d8ecf82256aa9604cb779d17943f5cb60b58ce (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
PR_JoinThreadPool
=================

Waits for all threads in a thread pool to complete, then releases
resources allocated to the thread pool.


Syntax
------

.. code::

   #include <prtpool.h>

   NSPR_API(PRStatus) PR_JoinThreadPool( PRThreadPool *tpool );


Parameter
~~~~~~~~~

The function has the following parameter:

``tpool``
   A pointer to a :ref:`PRThreadPool` structure previously created by a
   call to :ref:`PR_CreateThreadPool`.


Returns
~~~~~~~

:ref:`PRStatus`