summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_cexitmonitor.rst
blob: 91e95f9bff6263b6365060ae0c1351164125f067 (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
44
PR_CExitMonitor
===============

Decrement the entry count associated with a cached monitor.


Syntax
------

.. code::

   #include <prcmon.h>

   PRStatus PR_CExitMonitor(void *address);


Parameters
~~~~~~~~~~

The function has the following parameters:

``address``
   The address of the protected object--the same address previously
   passed to :ref:`PR_CEnterMonitor`.


Returns
~~~~~~~

The function returns one of the following values:

-  If successful, ``PR_SUCCESS``.
-  If unsuccessful, ``PR_FAILURE``. This may indicate that the address
   parameter is invalid or that the calling thread is not in the
   monitor.


Description
-----------

Using the value specified in the address parameter to find a monitor in
the monitor cache, :ref:`PR_CExitMonitor` decrements the entry count
associated with the monitor. If the decremented entry count is zero, the
monitor is exited.