summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_detachthread.rst
blob: c140f60c3772464006677431a8c260fd24c80bdd (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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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.