summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_newmonitor.rst
blob: 3f80340c7727ab09367571d10a16464bac7cacf2 (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
PR_NewMonitor
=============

Creates a new monitor object. The caller is responsible for the object
and is expected to destroy it when appropriate.


Syntax
------

.. code::

   #include <prmon.h>

   PRMonitor* PR_NewMonitor(void);


Returns
~~~~~~~

The function returns one of the following values:

-  If successful, a pointer to a :ref:`PRMonitor` object.
-  If unsuccessful (for example, if some operating system resource is
   unavailable), ``NULL``.


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

A newly created monitor has an entry count of zero.