summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_destroycondvar.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nspr/reference/pr_destroycondvar.rst')
-rw-r--r--docs/nspr/reference/pr_destroycondvar.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/nspr/reference/pr_destroycondvar.rst b/docs/nspr/reference/pr_destroycondvar.rst
new file mode 100644
index 0000000000..2347a2d389
--- /dev/null
+++ b/docs/nspr/reference/pr_destroycondvar.rst
@@ -0,0 +1,30 @@
+PR_DestroyCondVar
+=================
+
+Destroys a condition variable.
+
+
+Syntax
+------
+
+.. code::
+
+ #include <prcvar.h>
+
+ void PR_DestroyCondVar(PRCondVar *cvar);
+
+
+Parameter
+~~~~~~~~~
+
+:ref:`PR_DestroyCondVar` has one parameter:
+
+``cvar``
+ A pointer to the condition variable object to be destroyed.
+
+
+Description
+-----------
+
+Before calling :ref:`PR_DestroyCondVar`, the caller is responsible for
+ensuring that the condition variable is no longer in use.