summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_detachthread.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nspr/reference/pr_detachthread.rst')
-rw-r--r--docs/nspr/reference/pr_detachthread.rst57
1 files changed, 57 insertions, 0 deletions
diff --git a/docs/nspr/reference/pr_detachthread.rst b/docs/nspr/reference/pr_detachthread.rst
new file mode 100644
index 0000000000..c140f60c37
--- /dev/null
+++ b/docs/nspr/reference/pr_detachthread.rst
@@ -0,0 +1,57 @@
+PR_DetachThread
+===============
+
+.. container:: blockIndicator obsolete obsoleteHeader
+
+ | **Obsolete**
+ | This feature is obsolete. Although it may still work in some
+ browsers, its use is discouraged since it could be removed at any
+ time. Try to avoid using it.
+
+Disassociates a PRThread object from a native thread.
+
+
+Syntax
+------
+
+.. code::
+
+ #include <pprthread.h>
+
+ void PR_DetachThread(void);
+
+
+Parameters
+~~~~~~~~~~
+
+PR_DetachThread has no parameters.
+
+
+Returns
+~~~~~~~
+
+The function returns nothing.
+
+
+Description
+-----------
+
+This function detaches the NSPR thread from the currently executing
+native thread. The thread object and all related data attached to it are
+destroyed. The exit process is invoked. The call returns after the NSPR
+thread object is destroyed.
+
+This call is needed only if you attached the thread using
+:ref:`PR_AttachThread`.
+
+.. note::
+
+ **Note**: As of NSPR release v3.0, :ref:`PR_AttachThread` and
+ :ref:`PR_DetachThread` are obsolete. A native thread not created by NSPR
+ is automatically attached the first time it calls an NSPR function,
+ and automatically detached when it exits.
+
+In NSPR release 19980529B and earlier, it is necessary for a native
+thread not created by NSPR to call :ref:`PR_AttachThread` before it calls
+any NSPR functions, and call :ref:`PR_DetachThread` when it is done calling
+NSPR functions.