summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_atomicdecrement.rst
blob: a27b8d822777aa1531ed8cd5b571874e9091d868 (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
PR_AtomicDecrement
==================

Atomically decrements a 32-bit value.


Syntax
------

.. code::

   #include <pratom.h>

   PRInt32 PR_AtomicDecrement(PRInt32 *val);


Parameter
~~~~~~~~~

The function has the following parameter:

``val``
   A pointer to the value to decrement.


Returns
~~~~~~~

The function returns the decremented value (i.e., the result).


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

:ref:`PR_AtomicDecrement` first decrements the referenced variable by one.
The value returned is the referenced variable's final value. The
modification to memory is unconditional.