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