summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/prbool.rst
blob: 098cbae81b61f11230ded691fb1927077686e94b (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
PRBool
======

Boolean value.


Syntax
~~~~~~

.. code::

   #include <prtypes.h>

   typedef enum { PR_FALSE = 0, PR_TRUE = 1 } PRBool;


Description
~~~~~~~~~~~

Wherever possible, do not use PRBool in Mozilla C++ code. Use standard
C++ ``bool`` instead.

Otherwise, use :ref:`PRBool` for variables and parameter types. Use
``PR_FALSE`` and ``PR_TRUE`` for clarity of target type in assignments
and actual arguments. Use ``if (bool)``, ``while (!bool)``,
``(bool) ? x : y``, and so on to test Boolean values, just as you would
C ``int``-valued conditions.