summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_assert.rst
blob: 669c8d346a6b87fe5aa1160e5c481b0130a1e360 (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
PR_ASSERT
=========

Terminates execution when a given expression is ``FALSE``.


Syntax
------

.. code::

   #include <prlog.h>

   void PR_ASSERT ( expression );


Parameters
~~~~~~~~~~

The macro has this parameter:

expression
   Any valid C language expression that evaluates to ``TRUE`` or
   ``FALSE``.


Returns
~~~~~~~

Nothing


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

This macro evaluates the specified expression. When the result is zero
(``FALSE``) the application terminates; otherwise the application
continues. The macro converts the expression to a string and passes it
to ``PR_Assert``, using file and line parameters from the compile-time
environment.

This macro compiles to nothing if compile-time options are not specified
to enable logging.