summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_unlock.rst
blob: 4243a7510f4ef5f36587de28cf0d2fe58a420458 (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
PR_Unlock
=========

Releases a specified lock object. Releasing an unlocked lock results in
an error.

Attempting to release a lock that was locked by a different thread
causes undefined behavior.


Syntax
------

.. code::

   #include <prlock.h>

   PRStatus PR_Unlock(PRLock *lock);


Parameter
~~~~~~~~~

:ref:`PR_Unlock` has one parameter:

``lock``
   A pointer to a lock object to be released.


Returns
~~~~~~~

The function returns one of the following values:

-  If successful, ``PR_SUCCESS``.
-  If unsuccessful (for example, if the caller does not own the lock),
   ``PR_FAILURE``.


See Also
--------

-  `PR_Lock <PR_Lock>`__