summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_shutdownthreadpool.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nspr/reference/pr_shutdownthreadpool.rst')
-rw-r--r--docs/nspr/reference/pr_shutdownthreadpool.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/nspr/reference/pr_shutdownthreadpool.rst b/docs/nspr/reference/pr_shutdownthreadpool.rst
new file mode 100644
index 0000000000..3fb411af64
--- /dev/null
+++ b/docs/nspr/reference/pr_shutdownthreadpool.rst
@@ -0,0 +1,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`