fune/docs/nspr/reference/pl_hashtablelookup.rst

49 lines
949 B
ReStructuredText

PL_HashTableLookup
==================
Looks up the entry with the specified key and return its value.
.. _Syntax:
Syntax
------
.. code:: eval
#include <plhash.h>
void *PL_HashTableLookup(
PLHashTable *ht,
const void *key);
.. _Parameters:
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:
Returns
~~~~~~~
The value of the entry with the specified key, or ``NULL`` if there is
no such entry.
.. _Description:
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.