summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/plhashcomparator.rst
blob: 1310a6f37d50d2bd5d2b2e91f1f1c59830d904f7 (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
PLHashComparator
================


Syntax
------

.. code::

   #include <plhash.h>

   typedef PRIntn (PR_CALLBACK *PLHashComparator)(
     const void *v1,
     const void *v2);


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

:ref:`PLHashComparator` is a function type that compares two values of an
unspecified type. It returns a nonzero value if the two values are
equal, and 0 if the two values are not equal. :ref:`PLHashComparator`
defines the meaning of equality for the unspecified type.

For convenience, two comparator functions are provided.
:ref:`PL_CompareStrings` compare two character strings using ``strcmp``.
:ref:`PL_CompareValues` compares the values of the arguments v1 and v2
numerically.


Remark
------

The return value of :ref:`PLHashComparator` functions should be of type
:ref:`PRBool`.


See Also
--------

:ref:`PL_CompareStrings`, :ref:`PL_CompareValues`