File: pl_hashtableadd.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 (52 lines) | stat: -rw-r--r-- 1,127 bytes parent folder | download | duplicates (18) 
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
47
48
49
50
51
52
 
PL_HashTableAdd
===============

Add a new entry with the specified key and value to the hash table.


Syntax
------

.. code::

   #include <plhash.h>

   PLHashEntry *PL_HashTableAdd(
     PLHashTable *ht,
     const void *key,
     void *value);


Parameters
~~~~~~~~~~

The function has the following parameters:

``ht``
   A pointer to the the hash table to which to add the entry.
``key``
   A pointer to the key for the entry to be added.
``value``
   A pointer to the value for the entry to be added.


Returns
~~~~~~~

A pointer to the new entry.


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

Add a new entry with the specified key and value to the hash table.

If an entry with the same key already exists in the table, the
``freeEntry`` function is invoked with the ``HT_FREE_VALUE`` flag. You
can write your ``freeEntry`` function to free the value of the specified
entry if the old value should be freed. The default ``freeEntry``
function does not free the value of the entry.

:ref:`PL_HashTableAdd` returns ``NULL`` if there is not enough memory to
create a new entry. It doubles the number of buckets if the table is
overloaded.