summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pl_comparevalues.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nspr/reference/pl_comparevalues.rst')
-rw-r--r--docs/nspr/reference/pl_comparevalues.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/nspr/reference/pl_comparevalues.rst b/docs/nspr/reference/pl_comparevalues.rst
new file mode 100644
index 0000000000..9fef0b63f3
--- /dev/null
+++ b/docs/nspr/reference/pl_comparevalues.rst
@@ -0,0 +1,27 @@
+PL_CompareValues
+================
+
+Compares two ``void *`` values numerically.
+
+
+Syntax
+------
+
+.. code::
+
+ #include <plhash.h>
+
+ PRIntn PL_CompareValues(const
+ void *v1,
+ const void *v2);
+
+
+Description
+-----------
+
+:ref:`PL_CompareValues` compares the two ``void *`` values ``v1`` and
+``v2`` numerically, i.e., it returns the value of the expression ``v1``
+== ``v2``.
+
+:ref:`PL_CompareValues` can be used as the comparator function for integer
+or pointer-valued key or entry value.