summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pl_hashtablelookup.rst
blob: 236c08a874590df607d213bee95aca780241ee5a (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
42
43
44
45
PL_HashTableLookup
==================

Looks up the entry with the specified key and return its value.


Syntax
------

.. code::

   #include <plhash.h>

   void *PL_HashTableLookup(
     PLHashTable *ht,
     const void *key);


Parameters
~~~~~~~~~~

The function has the following parameters:

``ht``
   A pointer to the hash table in which to look up the entry specified
   by ``key``.
``key``
   A pointer to the key for the entry to look up.


Returns
~~~~~~~

The value of the entry with the specified key, or ``NULL`` if there is
no such entry.


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

If there is no entry with the specified key, :ref:`PL_HashTableLookup`
returns ``NULL``. This means that one cannot tell whether a ``NULL``
return value means the entry does not exist or the value of the entry is
``NULL``. Keep this ambiguity in mind if you want to store ``NULL``
values in a hash table.