File: pl_hashtableremove.rst

package info (click to toggle)
thunderbird 1%3A115.16.0esr-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 3,476,252 kB
  • sloc: cpp: 6,972,150; javascript: 5,209,211; ansic: 3,507,222; python: 1,137,609; asm: 432,531; xml: 205,149; java: 175,761; sh: 116,485; makefile: 22,152; perl: 13,971; objc: 12,561; yacc: 4,583; pascal: 2,840; lex: 1,720; ruby: 1,075; exp: 762; sql: 666; awk: 580; php: 436; lisp: 430; sed: 70; csh: 10
file content (46 lines) | stat: -rw-r--r-- 903 bytes parent folder | download | duplicates (19) 
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
 
PL_HashTableRemove
==================

Removes the entry with the specified key from the hash table.


Syntax
------

.. code::

   #include <plhash.h>

   PRBool PL_HashTableRemove(
     PLHashTable *ht,
     const void *key);


Parameters
~~~~~~~~~~

The function has the following parameters:

``ht``
   A pointer to the hash table from which to remove the entry.
``key``
   A pointer to the key for the entry to be removed.


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

If there is no entry in the table with the specified key,
:ref:`PL_HashTableRemove` returns ``PR_FALSE``. If the entry exists,
:ref:`PL_HashTableRemove` removes the entry from the table, invokes
``freeEntry`` with the ``HT_FREE_ENTRY`` flag to frees the entry, and
returns ``PR_TRUE``.

If the table is underloaded, :ref:`PL_HashTableRemove` also shrinks the
number of buckets by half.


Remark
------

This function should return :ref:`PRStatus`.