File: plhashcomparator.rst

package info (click to toggle)
firefox 149.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,767,760 kB
  • sloc: cpp: 7,416,064; javascript: 6,752,859; ansic: 3,774,850; python: 1,250,473; xml: 641,578; asm: 439,191; java: 186,617; sh: 56,634; makefile: 18,856; objc: 13,092; perl: 12,763; pascal: 5,960; yacc: 4,583; cs: 3,846; lex: 1,720; ruby: 1,002; php: 436; lisp: 258; awk: 105; sql: 66; sed: 53; csh: 10; exp: 6
file content (48 lines) | stat: -rw-r--r-- 991 bytes parent folder | download 
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
43
44
45
46
47
48
 
PLHashComparator
================

.. _plhashcomparator-syntax:

Syntax
------

.. code::

   #include <plhash.h>

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


.. _plhashcomparator-description:

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.


.. _plhashcomparator-remark:

Remark
------

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


.. _plhashcomparator-see-also:

See Also
--------

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