summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_newcondvar.rst
blob: 1ce70e8fe565e07cbe876d5d0212a329f13f788a (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
PR_NewCondVar
=============

Creates a new condition variable.


Syntax
------

.. code::

   #include <prcvar.h>

   PRCondVar* PR_NewCondVar(PRLock *lock);


Parameter
~~~~~~~~~

:ref:`PR_NewCondVar` has one parameter:

``lock``
   The identity of the mutex that protects the monitored data, including
   this condition variable.


Returns
~~~~~~~

The function returns one of the following values:

-  If successful, a pointer to the new condition variable object.
-  If unsuccessful (for example, if system resources are unavailable),
   ``NULL``.