summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_destroylock.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nspr/reference/pr_destroylock.rst')
-rw-r--r--docs/nspr/reference/pr_destroylock.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/nspr/reference/pr_destroylock.rst b/docs/nspr/reference/pr_destroylock.rst
new file mode 100644
index 0000000000..9ed566efc5
--- /dev/null
+++ b/docs/nspr/reference/pr_destroylock.rst
@@ -0,0 +1,30 @@
+PR_DestroyLock
+==============
+
+Destroys a specified lock object.
+
+
+Syntax
+------
+
+.. code::
+
+ #include <prlock.h>
+
+ void PR_DestroyLock(PRLock *lock);
+
+
+Parameter
+~~~~~~~~~
+
+:ref:`PR_DestroyLock` has one parameter:
+
+``lock``
+ A pointer to a lock object.
+
+Caution
+-------
+
+The caller must ensure that no thread is currently in a lock-specific
+function. Locks do not provide self-referential protection against
+deletion.