summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_atomicset.rst
blob: 3c9df0b1b9093e7f9a02b52aacf7635486b50b48 (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
PR_AtomicSet
============

Atomically sets a 32-bit value and return its previous contents.


Syntax
------

.. code::

   #include <pratom.h>

   PRInt32 PR_AtomicSet(
     PRInt32 *val,
     PRInt32 newval);


Parameters
~~~~~~~~~~

The function has the following parameter:

``val``
   A pointer to the value to be set.
``newval``
   The new value to assign to the ``val`` parameter.


Returns
~~~~~~~

The function returns the prior value of the referenced variable.


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

:ref:`PR_AtomicSet` first reads the value of var, then updates it with the
supplied value. The returned value is the value that was read\ *before*
memory was updated. The memory modification is unconditional--that is,
it isn't a test and set operation.