summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_shutdownthreadpool.rst
blob: 3fb411af648263e3b87e1c22d516f3e95c642768 (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
PR_ShutdownThreadPool
=====================

Notifies all threads in a thread pool to terminate.


Syntax
------

.. code::

   #include <prtpool.h>

   NSPR_API(PRStatus) PR_ShutdownThreadPool( 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`