summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_atomicincrement.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nspr/reference/pr_atomicincrement.rst')
-rw-r--r--docs/nspr/reference/pr_atomicincrement.rst37
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/nspr/reference/pr_atomicincrement.rst b/docs/nspr/reference/pr_atomicincrement.rst
new file mode 100644
index 0000000000..126ed7989c
--- /dev/null
+++ b/docs/nspr/reference/pr_atomicincrement.rst
@@ -0,0 +1,37 @@
+PR_AtomicIncrement
+==================
+
+Atomically increments a 32-bit value.
+
+
+Syntax
+------
+
+.. code::
+
+ #include <pratom.h>
+
+ PRInt32 PR_AtomicIncrement(PRInt32 *val);
+
+
+Parameter
+~~~~~~~~~
+
+The function has the following parameter:
+
+``val``
+ A pointer to the value to increment.
+
+
+Returns
+~~~~~~~
+
+The function returns the incremented value (i.e., the result).
+
+
+Description
+-----------
+
+The referenced variable is incremented by one. The result of the
+function is the value of the memory after the operation. The writing of
+the memory is unconditional.