Add license file
[platform/upstream/libxml2.git] / doc / devhelp / libxml2-hash.html
1 <?xml version="1.0" encoding="UTF-8"?>
2 <html>
3   <head>
4     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
5     <title>hash: Chained hash tables</title>
6     <meta name="generator" content="Libxml2 devhelp stylesheet"/>
7     <link rel="start" href="index.html" title="libxml2 Reference Manual"/>
8     <link rel="up" href="general.html" title="API"/>
9     <link rel="stylesheet" href="style.css" type="text/css"/>
10     <link rel="chapter" href="general.html" title="API"/>
11   </head>
12   <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13     <table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
14       <tr valign="middle">
15         <td>
16           <a accesskey="p" href="libxml2-globals.html">
17             <img src="left.png" width="24" height="24" border="0" alt="Prev"/>
18           </a>
19         </td>
20         <td>
21           <a accesskey="u" href="general.html">
22             <img src="up.png" width="24" height="24" border="0" alt="Up"/>
23           </a>
24         </td>
25         <td>
26           <a accesskey="h" href="index.html">
27             <img src="home.png" width="24" height="24" border="0" alt="Home"/>
28           </a>
29         </td>
30         <td>
31           <a accesskey="n" href="libxml2-list.html">
32             <img src="right.png" width="24" height="24" border="0" alt="Next"/>
33           </a>
34         </td>
35         <th width="100%" align="center">libxml2 Reference Manual</th>
36       </tr>
37     </table>
38     <h2>
39       <span class="refentrytitle">hash</span>
40     </h2>
41     <p>hash - Chained hash tables</p>
42     <p>This module implements the hash table support used in various places in the library. </p>
43     <p>Author(s): Bjorn Reese &lt;bjorn.reese@systematic.dk&gt; </p>
44     <div class="refsynopsisdiv">
45       <h2>Synopsis</h2>
46       <pre class="synopsis">#define <a href="#XML_CAST_FPTR">XML_CAST_FPTR</a>(fptr);
47 typedef struct _xmlHashTable <a href="#xmlHashTable">xmlHashTable</a>;
48 typedef <a href="libxml2-hash.html#xmlHashTable">xmlHashTable</a> * <a href="#xmlHashTablePtr">xmlHashTablePtr</a>;
49 void    <a href="#xmlHashScanFull">xmlHashScanFull</a>                  (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    <a href="libxml2-hash.html#xmlHashScannerFull">xmlHashScannerFull</a> f, <br/>                                  void * data);
50 void    <a href="#xmlHashScan">xmlHashScan</a>                  (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    <a href="libxml2-hash.html#xmlHashScanner">xmlHashScanner</a> f, <br/>                                  void * data);
51 typedef void <a href="#xmlHashScannerFull">xmlHashScannerFull</a>               (void * payload, <br/>                                   void * data, <br/>                                      const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name3);
52 <a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> <a href="#xmlHashCreateDict">xmlHashCreateDict</a>      (int size, <br/>                                         <a href="libxml2-dict.html#xmlDictPtr">xmlDictPtr</a> dict);
53 int     <a href="#xmlHashAddEntry">xmlHashAddEntry</a>                  (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        void * userdata);
54 int     <a href="#xmlHashUpdateEntry">xmlHashUpdateEntry</a>            (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        void * userdata, <br/>                                  <a href="libxml2-hash.html#xmlHashDeallocator">xmlHashDeallocator</a> f);
55 void *  <a href="#xmlHashQLookup3">xmlHashQLookup3</a>                  (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * prefix, <br/>                                      const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * prefix2, <br/>                                     const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * prefix3, <br/>                                     const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name3);
56 void *  <a href="#xmlHashQLookup2">xmlHashQLookup2</a>                  (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * prefix, <br/>                                      const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * prefix2, <br/>                                     const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2);
57 void    <a href="#xmlHashScan3">xmlHashScan3</a>                        (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name3, <br/>                                       <a href="libxml2-hash.html#xmlHashScanner">xmlHashScanner</a> f, <br/>                                  void * data);
58 typedef void <a href="#xmlHashScanner">xmlHashScanner</a>                       (void * payload, <br/>                                   void * data, <br/>                                      <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name);
59 typedef void <a href="#xmlHashDeallocator">xmlHashDeallocator</a>               (void * payload, <br/>                                   <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name);
60 <a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> <a href="#xmlHashCreate">xmlHashCreate</a>              (int size);
61 void    <a href="#xmlHashFree">xmlHashFree</a>                  (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    <a href="libxml2-hash.html#xmlHashDeallocator">xmlHashDeallocator</a> f);
62 void *  <a href="#xmlHashLookup">xmlHashLookup</a>                      (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name);
63 void *  <a href="#xmlHashQLookup">xmlHashQLookup</a>                    (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * prefix, <br/>                                      const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name);
64 int     <a href="#xmlHashUpdateEntry2">xmlHashUpdateEntry2</a>          (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       void * userdata, <br/>                                  <a href="libxml2-hash.html#xmlHashDeallocator">xmlHashDeallocator</a> f);
65 int     <a href="#xmlHashRemoveEntry2">xmlHashRemoveEntry2</a>          (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       <a href="libxml2-hash.html#xmlHashDeallocator">xmlHashDeallocator</a> f);
66 int     <a href="#xmlHashRemoveEntry3">xmlHashRemoveEntry3</a>          (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name3, <br/>                                       <a href="libxml2-hash.html#xmlHashDeallocator">xmlHashDeallocator</a> f);
67 <a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> <a href="#xmlHashCopy">xmlHashCopy</a>          (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    <a href="libxml2-hash.html#xmlHashCopier">xmlHashCopier</a> f);
68 void    <a href="#xmlHashScanFull3">xmlHashScanFull3</a>                (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name3, <br/>                                       <a href="libxml2-hash.html#xmlHashScannerFull">xmlHashScannerFull</a> f, <br/>                                  void * data);
69 int     <a href="#xmlHashUpdateEntry3">xmlHashUpdateEntry3</a>          (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name3, <br/>                                       void * userdata, <br/>                                  <a href="libxml2-hash.html#xmlHashDeallocator">xmlHashDeallocator</a> f);
70 void *  <a href="#xmlHashLookup3">xmlHashLookup3</a>                    (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name3);
71 void *  <a href="#xmlHashLookup2">xmlHashLookup2</a>                    (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2);
72 int     <a href="#xmlHashRemoveEntry">xmlHashRemoveEntry</a>            (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        <a href="libxml2-hash.html#xmlHashDeallocator">xmlHashDeallocator</a> f);
73 typedef void * <a href="#xmlHashCopier">xmlHashCopier</a>                       (void * payload, <br/>                                   <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name);
74 int     <a href="#xmlHashAddEntry2">xmlHashAddEntry2</a>                (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       void * userdata);
75 int     <a href="#xmlHashAddEntry3">xmlHashAddEntry3</a>                (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name3, <br/>                                       void * userdata);
76 int     <a href="#xmlHashSize">xmlHashSize</a>                  (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table);
77 </pre>
78     </div>
79     <div class="refsect1" lang="en">
80       <h2>Description</h2>
81     </div>
82     <div class="refsect1" lang="en">
83       <h2>Details</h2>
84       <div class="refsect2" lang="en">
85         <div class="refsect2" lang="en"><h3><a name="XML_CAST_FPTR">Macro </a>XML_CAST_FPTR</h3><pre class="programlisting">#define <a href="#XML_CAST_FPTR">XML_CAST_FPTR</a>(fptr);
86 </pre><p>Macro to do a casting from an object pointer to a function pointer without encountering a warning from gcc #define XML_CAST_FPTR(fptr) (*(void **)(&amp;fptr)) This macro violated ISO C aliasing rules (gcc4 on s390 broke) so it is disabled now</p><div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>fptr</tt></i>:</span></td><td>pointer to a function</td></tr></tbody></table></div>
87 </div>
88         <hr/>
89         <div class="refsect2" lang="en"><h3><a name="xmlHashTable">Structure </a>xmlHashTable</h3><pre class="programlisting">struct _xmlHashTable {
90 The content of this structure is not made public by the API.
91 } xmlHashTable;
92 </pre><p/>
93 </div>
94         <hr/>
95         <div class="refsect2" lang="en"><h3><a name="xmlHashTablePtr">Typedef </a>xmlHashTablePtr</h3><pre class="programlisting"><a href="libxml2-hash.html#xmlHashTable">xmlHashTable</a> * xmlHashTablePtr;
96 </pre><p/>
97 </div>
98         <hr/>
99         <div class="refsect2" lang="en"><h3><a name="xmlHashCopier"/>Function type xmlHashCopier</h3><pre class="programlisting">void * xmlHashCopier                   (void * payload, <br/>                                   <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name)<br/>
100 </pre><p>Callback to copy data from a hash.</p>
101 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>payload</tt></i>:</span></td><td>the data in the hash</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the name associated</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a copy of the data or NULL in case of error.</td></tr></tbody></table></div></div>
102         <hr/>
103         <div class="refsect2" lang="en"><h3><a name="xmlHashDeallocator"/>Function type xmlHashDeallocator</h3><pre class="programlisting">void xmlHashDeallocator              (void * payload, <br/>                                   <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name)<br/>
104 </pre><p>Callback to free data from a hash.</p>
105 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>payload</tt></i>:</span></td><td>the data in the hash</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the name associated</td></tr></tbody></table></div></div>
106         <hr/>
107         <div class="refsect2" lang="en"><h3><a name="xmlHashScanner"/>Function type xmlHashScanner</h3><pre class="programlisting">void xmlHashScanner                  (void * payload, <br/>                                   void * data, <br/>                                      <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name)<br/>
108 </pre><p>Callback when scanning data in a hash with the simple scanner.</p>
109 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>payload</tt></i>:</span></td><td>the data in the hash</td></tr><tr><td><span class="term"><i><tt>data</tt></i>:</span></td><td>extra scannner data</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the name associated</td></tr></tbody></table></div></div>
110         <hr/>
111         <div class="refsect2" lang="en"><h3><a name="xmlHashScannerFull"/>Function type xmlHashScannerFull</h3><pre class="programlisting">void xmlHashScannerFull              (void * payload, <br/>                                   void * data, <br/>                                      const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name3)<br/>
112 </pre><p>Callback when scanning data in a hash with the full scanner.</p>
113 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>payload</tt></i>:</span></td><td>the data in the hash</td></tr><tr><td><span class="term"><i><tt>data</tt></i>:</span></td><td>extra scannner data</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the name associated</td></tr><tr><td><span class="term"><i><tt>name2</tt></i>:</span></td><td>the second name associated</td></tr><tr><td><span class="term"><i><tt>name3</tt></i>:</span></td><td>the third name associated</td></tr></tbody></table></div></div>
114         <hr/>
115         <div class="refsect2" lang="en"><h3><a name="xmlHashAddEntry"/>xmlHashAddEntry ()</h3><pre class="programlisting">int   xmlHashAddEntry                 (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        void * userdata)<br/>
116 </pre><p>Add the @userdata to the hash @table. This can later be retrieved by using the @name. Duplicate names generate errors.</p>
117 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the name of the userdata</td></tr><tr><td><span class="term"><i><tt>userdata</tt></i>:</span></td><td>a pointer to the userdata</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 the addition succeeded and -1 in case of error.</td></tr></tbody></table></div></div>
118         <hr/>
119         <div class="refsect2" lang="en"><h3><a name="xmlHashAddEntry2"/>xmlHashAddEntry2 ()</h3><pre class="programlisting">int xmlHashAddEntry2                (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       void * userdata)<br/>
120 </pre><p>Add the @userdata to the hash @table. This can later be retrieved by using the (@name, @name2) tuple. Duplicate tuples generate errors.</p>
121 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the name of the userdata</td></tr><tr><td><span class="term"><i><tt>name2</tt></i>:</span></td><td>a second name of the userdata</td></tr><tr><td><span class="term"><i><tt>userdata</tt></i>:</span></td><td>a pointer to the userdata</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 the addition succeeded and -1 in case of error.</td></tr></tbody></table></div></div>
122         <hr/>
123         <div class="refsect2" lang="en"><h3><a name="xmlHashAddEntry3"/>xmlHashAddEntry3 ()</h3><pre class="programlisting">int xmlHashAddEntry3                (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name3, <br/>                                       void * userdata)<br/>
124 </pre><p>Add the @userdata to the hash @table. This can later be retrieved by using the tuple (@name, @name2, @name3). Duplicate entries generate errors.</p>
125 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the name of the userdata</td></tr><tr><td><span class="term"><i><tt>name2</tt></i>:</span></td><td>a second name of the userdata</td></tr><tr><td><span class="term"><i><tt>name3</tt></i>:</span></td><td>a third name of the userdata</td></tr><tr><td><span class="term"><i><tt>userdata</tt></i>:</span></td><td>a pointer to the userdata</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 the addition succeeded and -1 in case of error.</td></tr></tbody></table></div></div>
126         <hr/>
127         <div class="refsect2" lang="en"><h3><a name="xmlHashCopy"/>xmlHashCopy ()</h3><pre class="programlisting"><a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a>       xmlHashCopy             (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    <a href="libxml2-hash.html#xmlHashCopier">xmlHashCopier</a> f)<br/>
128 </pre><p>Scan the hash @table and applied @f to each value.</p>
129 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>f</tt></i>:</span></td><td>the copier function for items in the hash</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the new table or NULL in case of error.</td></tr></tbody></table></div></div>
130         <hr/>
131         <div class="refsect2" lang="en"><h3><a name="xmlHashCreate"/>xmlHashCreate ()</h3><pre class="programlisting"><a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a>   xmlHashCreate           (int size)<br/>
132 </pre><p>Create a new xmlHashTablePtr.</p>
133 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>size</tt></i>:</span></td><td>the size of the hash table</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the newly created object, or NULL if an error occured.</td></tr></tbody></table></div></div>
134         <hr/>
135         <div class="refsect2" lang="en"><h3><a name="xmlHashCreateDict"/>xmlHashCreateDict ()</h3><pre class="programlisting"><a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a>   xmlHashCreateDict       (int size, <br/>                                         <a href="libxml2-dict.html#xmlDictPtr">xmlDictPtr</a> dict)<br/>
136 </pre><p>Create a new <a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> which will use @dict as the internal dictionary</p>
137 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>size</tt></i>:</span></td><td>the size of the hash table</td></tr><tr><td><span class="term"><i><tt>dict</tt></i>:</span></td><td>a dictionary to use for the hash</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the newly created object, or NULL if an error occured.</td></tr></tbody></table></div></div>
138         <hr/>
139         <div class="refsect2" lang="en"><h3><a name="xmlHashFree"/>xmlHashFree ()</h3><pre class="programlisting">void  xmlHashFree                     (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    <a href="libxml2-hash.html#xmlHashDeallocator">xmlHashDeallocator</a> f)<br/>
140 </pre><p>Free the hash @table and its contents. The userdata is deallocated with @f if provided.</p>
141 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>f</tt></i>:</span></td><td>the deallocator function for items in the hash</td></tr></tbody></table></div></div>
142         <hr/>
143         <div class="refsect2" lang="en"><h3><a name="xmlHashLookup"/>xmlHashLookup ()</h3><pre class="programlisting">void *    xmlHashLookup                   (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name)<br/>
144 </pre><p>Find the userdata specified by the @name.</p>
145 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the name of the userdata</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the pointer to the userdata</td></tr></tbody></table></div></div>
146         <hr/>
147         <div class="refsect2" lang="en"><h3><a name="xmlHashLookup2"/>xmlHashLookup2 ()</h3><pre class="programlisting">void *  xmlHashLookup2                  (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2)<br/>
148 </pre><p>Find the userdata specified by the (@name, @name2) tuple.</p>
149 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the name of the userdata</td></tr><tr><td><span class="term"><i><tt>name2</tt></i>:</span></td><td>a second name of the userdata</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the pointer to the userdata</td></tr></tbody></table></div></div>
150         <hr/>
151         <div class="refsect2" lang="en"><h3><a name="xmlHashLookup3"/>xmlHashLookup3 ()</h3><pre class="programlisting">void *  xmlHashLookup3                  (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name3)<br/>
152 </pre><p>Find the userdata specified by the (@name, @name2, @name3) tuple.</p>
153 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the name of the userdata</td></tr><tr><td><span class="term"><i><tt>name2</tt></i>:</span></td><td>a second name of the userdata</td></tr><tr><td><span class="term"><i><tt>name3</tt></i>:</span></td><td>a third name of the userdata</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the a pointer to the userdata</td></tr></tbody></table></div></div>
154         <hr/>
155         <div class="refsect2" lang="en"><h3><a name="xmlHashQLookup"/>xmlHashQLookup ()</h3><pre class="programlisting">void *  xmlHashQLookup                  (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * prefix, <br/>                                      const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name)<br/>
156 </pre><p>Find the userdata specified by the QName @prefix:@name/@name.</p>
157 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>prefix</tt></i>:</span></td><td>the prefix of the userdata</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the name of the userdata</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the pointer to the userdata</td></tr></tbody></table></div></div>
158         <hr/>
159         <div class="refsect2" lang="en"><h3><a name="xmlHashQLookup2"/>xmlHashQLookup2 ()</h3><pre class="programlisting">void *        xmlHashQLookup2                 (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * prefix, <br/>                                      const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * prefix2, <br/>                                     const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2)<br/>
160 </pre><p>Find the userdata specified by the QNames tuple</p>
161 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>prefix</tt></i>:</span></td><td>the prefix of the userdata</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the name of the userdata</td></tr><tr><td><span class="term"><i><tt>prefix2</tt></i>:</span></td><td>the second prefix of the userdata</td></tr><tr><td><span class="term"><i><tt>name2</tt></i>:</span></td><td>a second name of the userdata</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the pointer to the userdata</td></tr></tbody></table></div></div>
162         <hr/>
163         <div class="refsect2" lang="en"><h3><a name="xmlHashQLookup3"/>xmlHashQLookup3 ()</h3><pre class="programlisting">void *        xmlHashQLookup3                 (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * prefix, <br/>                                      const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * prefix2, <br/>                                     const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * prefix3, <br/>                                     const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name3)<br/>
164 </pre><p>Find the userdata specified by the (@name, @name2, @name3) tuple.</p>
165 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>prefix</tt></i>:</span></td><td>the prefix of the userdata</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the name of the userdata</td></tr><tr><td><span class="term"><i><tt>prefix2</tt></i>:</span></td><td>the second prefix of the userdata</td></tr><tr><td><span class="term"><i><tt>name2</tt></i>:</span></td><td>a second name of the userdata</td></tr><tr><td><span class="term"><i><tt>prefix3</tt></i>:</span></td><td>the third prefix of the userdata</td></tr><tr><td><span class="term"><i><tt>name3</tt></i>:</span></td><td>a third name of the userdata</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the a pointer to the userdata</td></tr></tbody></table></div></div>
166         <hr/>
167         <div class="refsect2" lang="en"><h3><a name="xmlHashRemoveEntry"/>xmlHashRemoveEntry ()</h3><pre class="programlisting">int     xmlHashRemoveEntry              (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        <a href="libxml2-hash.html#xmlHashDeallocator">xmlHashDeallocator</a> f)<br/>
168 </pre><p>Find the userdata specified by the @name and remove it from the hash @table. Existing userdata for this tuple will be removed and freed with @f.</p>
169 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the name of the userdata</td></tr><tr><td><span class="term"><i><tt>f</tt></i>:</span></td><td>the deallocator function for removed item (if any)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 if the removal succeeded and -1 in case of error or not found.</td></tr></tbody></table></div></div>
170         <hr/>
171         <div class="refsect2" lang="en"><h3><a name="xmlHashRemoveEntry2"/>xmlHashRemoveEntry2 ()</h3><pre class="programlisting">int   xmlHashRemoveEntry2             (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       <a href="libxml2-hash.html#xmlHashDeallocator">xmlHashDeallocator</a> f)<br/>
172 </pre><p>Find the userdata specified by the (@name, @name2) tuple and remove it from the hash @table. Existing userdata for this tuple will be removed and freed with @f.</p>
173 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the name of the userdata</td></tr><tr><td><span class="term"><i><tt>name2</tt></i>:</span></td><td>a second name of the userdata</td></tr><tr><td><span class="term"><i><tt>f</tt></i>:</span></td><td>the deallocator function for removed item (if any)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 if the removal succeeded and -1 in case of error or not found.</td></tr></tbody></table></div></div>
174         <hr/>
175         <div class="refsect2" lang="en"><h3><a name="xmlHashRemoveEntry3"/>xmlHashRemoveEntry3 ()</h3><pre class="programlisting">int   xmlHashRemoveEntry3             (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name3, <br/>                                       <a href="libxml2-hash.html#xmlHashDeallocator">xmlHashDeallocator</a> f)<br/>
176 </pre><p>Find the userdata specified by the (@name, @name2, @name3) tuple and remove it from the hash @table. Existing userdata for this tuple will be removed and freed with @f.</p>
177 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the name of the userdata</td></tr><tr><td><span class="term"><i><tt>name2</tt></i>:</span></td><td>a second name of the userdata</td></tr><tr><td><span class="term"><i><tt>name3</tt></i>:</span></td><td>a third name of the userdata</td></tr><tr><td><span class="term"><i><tt>f</tt></i>:</span></td><td>the deallocator function for removed item (if any)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 if the removal succeeded and -1 in case of error or not found.</td></tr></tbody></table></div></div>
178         <hr/>
179         <div class="refsect2" lang="en"><h3><a name="xmlHashScan"/>xmlHashScan ()</h3><pre class="programlisting">void  xmlHashScan                     (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    <a href="libxml2-hash.html#xmlHashScanner">xmlHashScanner</a> f, <br/>                                  void * data)<br/>
180 </pre><p>Scan the hash @table and applied @f to each value.</p>
181 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>f</tt></i>:</span></td><td>the scanner function for items in the hash</td></tr><tr><td><span class="term"><i><tt>data</tt></i>:</span></td><td>extra data passed to f</td></tr></tbody></table></div></div>
182         <hr/>
183         <div class="refsect2" lang="en"><h3><a name="xmlHashScan3"/>xmlHashScan3 ()</h3><pre class="programlisting">void        xmlHashScan3                    (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name3, <br/>                                       <a href="libxml2-hash.html#xmlHashScanner">xmlHashScanner</a> f, <br/>                                  void * data)<br/>
184 </pre><p>Scan the hash @table and applied @f to each value matching (@name, @name2, @name3) tuple. If one of the names is null, the comparison is considered to match.</p>
185 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the name of the userdata or NULL</td></tr><tr><td><span class="term"><i><tt>name2</tt></i>:</span></td><td>a second name of the userdata or NULL</td></tr><tr><td><span class="term"><i><tt>name3</tt></i>:</span></td><td>a third name of the userdata or NULL</td></tr><tr><td><span class="term"><i><tt>f</tt></i>:</span></td><td>the scanner function for items in the hash</td></tr><tr><td><span class="term"><i><tt>data</tt></i>:</span></td><td>extra data passed to f</td></tr></tbody></table></div></div>
186         <hr/>
187         <div class="refsect2" lang="en"><h3><a name="xmlHashScanFull"/>xmlHashScanFull ()</h3><pre class="programlisting">void  xmlHashScanFull                 (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    <a href="libxml2-hash.html#xmlHashScannerFull">xmlHashScannerFull</a> f, <br/>                                  void * data)<br/>
188 </pre><p>Scan the hash @table and applied @f to each value.</p>
189 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>f</tt></i>:</span></td><td>the scanner function for items in the hash</td></tr><tr><td><span class="term"><i><tt>data</tt></i>:</span></td><td>extra data passed to f</td></tr></tbody></table></div></div>
190         <hr/>
191         <div class="refsect2" lang="en"><h3><a name="xmlHashScanFull3"/>xmlHashScanFull3 ()</h3><pre class="programlisting">void        xmlHashScanFull3                (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name3, <br/>                                       <a href="libxml2-hash.html#xmlHashScannerFull">xmlHashScannerFull</a> f, <br/>                                  void * data)<br/>
192 </pre><p>Scan the hash @table and applied @f to each value matching (@name, @name2, @name3) tuple. If one of the names is null, the comparison is considered to match.</p>
193 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the name of the userdata or NULL</td></tr><tr><td><span class="term"><i><tt>name2</tt></i>:</span></td><td>a second name of the userdata or NULL</td></tr><tr><td><span class="term"><i><tt>name3</tt></i>:</span></td><td>a third name of the userdata or NULL</td></tr><tr><td><span class="term"><i><tt>f</tt></i>:</span></td><td>the scanner function for items in the hash</td></tr><tr><td><span class="term"><i><tt>data</tt></i>:</span></td><td>extra data passed to f</td></tr></tbody></table></div></div>
194         <hr/>
195         <div class="refsect2" lang="en"><h3><a name="xmlHashSize"/>xmlHashSize ()</h3><pre class="programlisting">int   xmlHashSize                     (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table)<br/>
196 </pre><p>Query the number of elements installed in the hash @table.</p>
197 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of elements in the hash table or -1 in case of error</td></tr></tbody></table></div></div>
198         <hr/>
199         <div class="refsect2" lang="en"><h3><a name="xmlHashUpdateEntry"/>xmlHashUpdateEntry ()</h3><pre class="programlisting">int     xmlHashUpdateEntry              (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        void * userdata, <br/>                                  <a href="libxml2-hash.html#xmlHashDeallocator">xmlHashDeallocator</a> f)<br/>
200 </pre><p>Add the @userdata to the hash @table. This can later be retrieved by using the @name. Existing entry for this @name will be removed and freed with @f if found.</p>
201 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the name of the userdata</td></tr><tr><td><span class="term"><i><tt>userdata</tt></i>:</span></td><td>a pointer to the userdata</td></tr><tr><td><span class="term"><i><tt>f</tt></i>:</span></td><td>the deallocator function for replaced item (if any)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 the addition succeeded and -1 in case of error.</td></tr></tbody></table></div></div>
202         <hr/>
203         <div class="refsect2" lang="en"><h3><a name="xmlHashUpdateEntry2"/>xmlHashUpdateEntry2 ()</h3><pre class="programlisting">int   xmlHashUpdateEntry2             (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       void * userdata, <br/>                                  <a href="libxml2-hash.html#xmlHashDeallocator">xmlHashDeallocator</a> f)<br/>
204 </pre><p>Add the @userdata to the hash @table. This can later be retrieved by using the (@name, @name2) tuple. Existing entry for this tuple will be removed and freed with @f if found.</p>
205 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the name of the userdata</td></tr><tr><td><span class="term"><i><tt>name2</tt></i>:</span></td><td>a second name of the userdata</td></tr><tr><td><span class="term"><i><tt>userdata</tt></i>:</span></td><td>a pointer to the userdata</td></tr><tr><td><span class="term"><i><tt>f</tt></i>:</span></td><td>the deallocator function for replaced item (if any)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 the addition succeeded and -1 in case of error.</td></tr></tbody></table></div></div>
206         <hr/>
207         <div class="refsect2" lang="en"><h3><a name="xmlHashUpdateEntry3"/>xmlHashUpdateEntry3 ()</h3><pre class="programlisting">int   xmlHashUpdateEntry3             (<a href="libxml2-hash.html#xmlHashTablePtr">xmlHashTablePtr</a> table, <br/>                                    const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name2, <br/>                                       const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name3, <br/>                                       void * userdata, <br/>                                  <a href="libxml2-hash.html#xmlHashDeallocator">xmlHashDeallocator</a> f)<br/>
208 </pre><p>Add the @userdata to the hash @table. This can later be retrieved by using the tuple (@name, @name2, @name3). Existing entry for this tuple will be removed and freed with @f if found.</p>
209 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>table</tt></i>:</span></td><td>the hash table</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the name of the userdata</td></tr><tr><td><span class="term"><i><tt>name2</tt></i>:</span></td><td>a second name of the userdata</td></tr><tr><td><span class="term"><i><tt>name3</tt></i>:</span></td><td>a third name of the userdata</td></tr><tr><td><span class="term"><i><tt>userdata</tt></i>:</span></td><td>a pointer to the userdata</td></tr><tr><td><span class="term"><i><tt>f</tt></i>:</span></td><td>the deallocator function for replaced item (if any)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 the addition succeeded and -1 in case of error.</td></tr></tbody></table></div></div>
210         <hr/>
211       </div>
212     </div>
213   </body>
214 </html>