summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pl_hashtabledestroy.rst
blob: 9b45e5a6091949b1d78a13b341ae5dddddb85513 (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
PL_HashTableDestroy
===================

Frees the table and all the entries.


Syntax
------

.. code::

   #include <plhash.h>

   void PL_HashTableDestroy(PLHashTable *ht);


Parameter
~~~~~~~~~

The function has the following parameter:

``ht``
   A pointer to the hash table to be destroyed.


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

:ref:`PL_HashTableDestroy` frees all the entries in the table and the table
itself. The entries are freed by the ``freeEntry`` function (with the
``HT_FREE_ENTRY`` flag) in the ``allocOps`` structure supplied when the
table was created.