summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pl_comparestrings.rst
blob: 46050c74b2e988cc48e9133df13afd42438e8e6d (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
PL_CompareStrings
=================

Compares two character strings.


Syntax
------

.. code::

   #include <plhash.h>

   PRIntn PL_CompareStrings(
     const void *v1,
     const void *v2);


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

:ref:`PL_CompareStrings` compares ``v1`` and ``v2`` as character strings
using ``strcmp``. If the two strings are equal, it returns 1. If the two
strings are not equal, it returns 0.

:ref:`PL_CompareStrings` can be used as the comparator function for
string-valued key or entry value.