← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to docs/reference/libedataserver/html/libedataserver-e-xml-hash-utils.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libedataserver/html/libedataserver-e-xml-hash-utils.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>EXMLHash</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Utilities (libedataserver)">
 
8
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Utilities (libedataserver)">
 
9
<link rel="prev" href="libedataserver-e-url.html" title="EUrl">
 
10
<link rel="next" href="libedataserver-Version-Information.html" title="Version Information">
 
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="libedataserver-e-url.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">Evolution-Data-Server Manual: Utilities (libedataserver)</th>
 
21
<td><a accesskey="n" href="libedataserver-Version-Information.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#libedataserver-e-xml-hash-utils.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#libedataserver-e-xml-hash-utils.description" class="shortcut">Description</a>
 
27
</td></tr>
 
28
</table>
 
29
<div class="refentry" title="EXMLHash">
 
30
<a name="libedataserver-e-xml-hash-utils"></a><div class="titlepage"></div>
 
31
<div class="refnamediv"><table width="100%"><tr>
 
32
<td valign="top">
 
33
<h2><span class="refentrytitle"><a name="libedataserver-e-xml-hash-utils.top_of_page"></a>EXMLHash</span></h2>
 
34
<p>EXMLHash — Functions for manipulating xml as a hash table.</p>
 
35
</td>
 
36
<td valign="top" align="right"></td>
 
37
</tr></table></div>
 
38
<div class="refsynopsisdiv" title="Synopsis">
 
39
<a name="libedataserver-e-xml-hash-utils.synopsis"></a><h2>Synopsis</h2>
 
40
<pre class="synopsis">enum                <a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHashType" title="enum EXmlHashType">EXmlHashType</a>;
 
41
<span class="returnvalue">GHashTable</span> *        <a class="link" href="libedataserver-e-xml-hash-utils.html#e-xml-to-hash" title="e_xml_to_hash ()">e_xml_to_hash</a>                       (<em class="parameter"><code><span class="type">xmlDoc</span> *doc</code></em>,
 
42
                                                         <em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHashType" title="enum EXmlHashType"><span class="type">EXmlHashType</span></a> type</code></em>);
 
43
<span class="returnvalue">xmlDoc</span> *            <a class="link" href="libedataserver-e-xml-hash-utils.html#e-xml-from-hash" title="e_xml_from_hash ()">e_xml_from_hash</a>                     (<em class="parameter"><code><span class="type">GHashTable</span> *hash</code></em>,
 
44
                                                         <em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHashType" title="enum EXmlHashType"><span class="type">EXmlHashType</span></a> type</code></em>,
 
45
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *root_node</code></em>);
 
46
<span class="returnvalue">void</span>                <a class="link" href="libedataserver-e-xml-hash-utils.html#e-xml-destroy-hash" title="e_xml_destroy_hash ()">e_xml_destroy_hash</a>                  (<em class="parameter"><code><span class="type">GHashTable</span> *hash</code></em>);
 
47
enum                <a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHashStatus" title="enum EXmlHashStatus">EXmlHashStatus</a>;
 
48
<span class="returnvalue">void</span>                (<a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHashFunc" title="EXmlHashFunc ()">*EXmlHashFunc</a>)                     (<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
 
49
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>,
 
50
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
 
51
<span class="returnvalue">gboolean</span>            (<a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHashRemoveFunc" title="EXmlHashRemoveFunc ()">*EXmlHashRemoveFunc</a>)               (<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
 
52
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>,
 
53
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
 
54
typedef             <a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash">EXmlHash</a>;
 
55
<a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="returnvalue">EXmlHash</span></a> *          <a class="link" href="libedataserver-e-xml-hash-utils.html#e-xmlhash-new" title="e_xmlhash_new ()">e_xmlhash_new</a>                       (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);
 
56
<span class="returnvalue">void</span>                <a class="link" href="libedataserver-e-xml-hash-utils.html#e-xmlhash-add" title="e_xmlhash_add ()">e_xmlhash_add</a>                       (<em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> *hash</code></em>,
 
57
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
 
58
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *data</code></em>);
 
59
<span class="returnvalue">void</span>                <a class="link" href="libedataserver-e-xml-hash-utils.html#e-xmlhash-remove" title="e_xmlhash_remove ()">e_xmlhash_remove</a>                    (<em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> *hash</code></em>,
 
60
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);
 
61
<a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHashStatus" title="enum EXmlHashStatus"><span class="returnvalue">EXmlHashStatus</span></a>      <a class="link" href="libedataserver-e-xml-hash-utils.html#e-xmlhash-compare" title="e_xmlhash_compare ()">e_xmlhash_compare</a>                   (<em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> *hash</code></em>,
 
62
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
 
63
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *compare_data</code></em>);
 
64
<span class="returnvalue">void</span>                <a class="link" href="libedataserver-e-xml-hash-utils.html#e-xmlhash-foreach-key" title="e_xmlhash_foreach_key ()">e_xmlhash_foreach_key</a>               (<em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> *hash</code></em>,
 
65
                                                         <em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHashFunc" title="EXmlHashFunc ()"><span class="type">EXmlHashFunc</span></a> func</code></em>,
 
66
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
 
67
<span class="returnvalue">void</span>                <a class="link" href="libedataserver-e-xml-hash-utils.html#e-xmlhash-foreach-key-remove" title="e_xmlhash_foreach_key_remove ()">e_xmlhash_foreach_key_remove</a>        (<em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> *hash</code></em>,
 
68
                                                         <em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHashRemoveFunc" title="EXmlHashRemoveFunc ()"><span class="type">EXmlHashRemoveFunc</span></a> func</code></em>,
 
69
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
 
70
<span class="returnvalue">void</span>                <a class="link" href="libedataserver-e-xml-hash-utils.html#e-xmlhash-write" title="e_xmlhash_write ()">e_xmlhash_write</a>                     (<em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> *hash</code></em>);
 
71
<span class="returnvalue">void</span>                <a class="link" href="libedataserver-e-xml-hash-utils.html#e-xmlhash-destroy" title="e_xmlhash_destroy ()">e_xmlhash_destroy</a>                   (<em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> *hash</code></em>);
 
72
</pre>
 
73
</div>
 
74
<div class="refsect1" title="Description">
 
75
<a name="libedataserver-e-xml-hash-utils.description"></a><h2>Description</h2>
 
76
<p>
 
77
</p>
 
78
</div>
 
79
<div class="refsect1" title="Details">
 
80
<a name="libedataserver-e-xml-hash-utils.details"></a><h2>Details</h2>
 
81
<div class="refsect2" title="enum EXmlHashType">
 
82
<a name="EXmlHashType"></a><h3>enum EXmlHashType</h3>
 
83
<pre class="programlisting">typedef enum {
 
84
        E_XML_HASH_TYPE_OBJECT_UID,
 
85
        E_XML_HASH_TYPE_PROPERTY
 
86
} EXmlHashType;
 
87
</pre>
 
88
<div class="variablelist"><table border="0">
 
89
<col align="left" valign="top">
 
90
<tbody>
 
91
<tr>
 
92
<td><p><a name="E-XML-HASH-TYPE-OBJECT-UID:CAPS"></a><span class="term"><code class="literal">E_XML_HASH_TYPE_OBJECT_UID</code></span></p></td>
 
93
<td>Use the object UID as the hash key.
 
94
</td>
 
95
</tr>
 
96
<tr>
 
97
<td><p><a name="E-XML-HASH-TYPE-PROPERTY:CAPS"></a><span class="term"><code class="literal">E_XML_HASH_TYPE_PROPERTY</code></span></p></td>
 
98
<td>Use the property name as the hash key.
 
99
</td>
 
100
</tr>
 
101
</tbody>
 
102
</table></div>
 
103
</div>
 
104
<hr>
 
105
<div class="refsect2" title="e_xml_to_hash ()">
 
106
<a name="e-xml-to-hash"></a><h3>e_xml_to_hash ()</h3>
 
107
<pre class="programlisting"><span class="returnvalue">GHashTable</span> *        e_xml_to_hash                       (<em class="parameter"><code><span class="type">xmlDoc</span> *doc</code></em>,
 
108
                                                         <em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHashType" title="enum EXmlHashType"><span class="type">EXmlHashType</span></a> type</code></em>);</pre>
 
109
<p>
 
110
Creates a <span class="type">GHashTable</span> representation of the <span class="type">xmlDoc</span> <em class="parameter"><code>doc</code></em>.
 
111
If <em class="parameter"><code>type</code></em> is * <em class="parameter"><code>E_XML_HASH_TYPE_PROPERTY</code></em>, all XML nodes will be
 
112
indexed in the <span class="type">GHashTable</span> by name. If <em class="parameter"><code>type</code></em> is
 
113
<a class="link" href="libedataserver-e-xml-hash-utils.html#E-XML-HASH-TYPE-OBJECT-UID:CAPS"><code class="literal">E_XML_HASH_TYPE_OBJECT_UID</code></a>, then XML objects will be indexed in
 
114
the hash by their UID (other nodes will still be indexed by name).
 
115
</p>
 
116
<div class="variablelist"><table border="0">
 
117
<col align="left" valign="top">
 
118
<tbody>
 
119
<tr>
 
120
<td><p><span class="term"><em class="parameter"><code>doc</code></em> :</span></p></td>
 
121
<td>The <span class="type">xmlDoc</span> to store in a hash table.
 
122
</td>
 
123
</tr>
 
124
<tr>
 
125
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
 
126
<td>The value type to use as a key in the hash table.
 
127
</td>
 
128
</tr>
 
129
<tr>
 
130
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
131
<td> The newly-created <span class="type">GHashTable</span> representation of <em class="parameter"><code>doc</code></em>.
 
132
</td>
 
133
</tr>
 
134
</tbody>
 
135
</table></div>
 
136
</div>
 
137
<hr>
 
138
<div class="refsect2" title="e_xml_from_hash ()">
 
139
<a name="e-xml-from-hash"></a><h3>e_xml_from_hash ()</h3>
 
140
<pre class="programlisting"><span class="returnvalue">xmlDoc</span> *            e_xml_from_hash                     (<em class="parameter"><code><span class="type">GHashTable</span> *hash</code></em>,
 
141
                                                         <em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHashType" title="enum EXmlHashType"><span class="type">EXmlHashType</span></a> type</code></em>,
 
142
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *root_node</code></em>);</pre>
 
143
<p>
 
144
Uses the key/value pair representation of an XML structure in <em class="parameter"><code>hash</code></em>
 
145
to build an equivalent <span class="type">xmlDoc</span>. This is the reverse of
 
146
<a class="link" href="libedataserver-e-xml-hash-utils.html#e-xml-to-hash" title="e_xml_to_hash ()"><code class="function">e_xml_to_hash()</code></a>.
 
147
</p>
 
148
<div class="variablelist"><table border="0">
 
149
<col align="left" valign="top">
 
150
<tbody>
 
151
<tr>
 
152
<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td>
 
153
<td>The <span class="type">GHashTable</span> to extract the XML from.
 
154
</td>
 
155
</tr>
 
156
<tr>
 
157
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
 
158
<td>The <a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHashType" title="enum EXmlHashType"><span class="type">EXmlHashType</span></a> used to store the XML.
 
159
</td>
 
160
</tr>
 
161
<tr>
 
162
<td><p><span class="term"><em class="parameter"><code>root_node</code></em> :</span></p></td>
 
163
<td>
 
164
</td>
 
165
</tr>
 
166
<tr>
 
167
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
168
<td> The <span class="type">xmlDoc</span> created from the data in <em class="parameter"><code>hash</code></em>.
 
169
</td>
 
170
</tr>
 
171
</tbody>
 
172
</table></div>
 
173
</div>
 
174
<hr>
 
175
<div class="refsect2" title="e_xml_destroy_hash ()">
 
176
<a name="e-xml-destroy-hash"></a><h3>e_xml_destroy_hash ()</h3>
 
177
<pre class="programlisting"><span class="returnvalue">void</span>                e_xml_destroy_hash                  (<em class="parameter"><code><span class="type">GHashTable</span> *hash</code></em>);</pre>
 
178
<p>
 
179
Frees the memory used by <em class="parameter"><code>hash</code></em> and its contents.
 
180
</p>
 
181
<div class="variablelist"><table border="0">
 
182
<col align="left" valign="top">
 
183
<tbody><tr>
 
184
<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td>
 
185
<td>The <span class="type">GHashTable</span> to destroy.
 
186
</td>
 
187
</tr></tbody>
 
188
</table></div>
 
189
</div>
 
190
<hr>
 
191
<div class="refsect2" title="enum EXmlHashStatus">
 
192
<a name="EXmlHashStatus"></a><h3>enum EXmlHashStatus</h3>
 
193
<pre class="programlisting">typedef enum {
 
194
        E_XMLHASH_STATUS_SAME,
 
195
        E_XMLHASH_STATUS_DIFFERENT,
 
196
        E_XMLHASH_STATUS_NOT_FOUND
 
197
} EXmlHashStatus;
 
198
</pre>
 
199
<div class="variablelist"><table border="0">
 
200
<col align="left" valign="top">
 
201
<tbody>
 
202
<tr>
 
203
<td><p><a name="E-XMLHASH-STATUS-SAME:CAPS"></a><span class="term"><code class="literal">E_XMLHASH_STATUS_SAME</code></span></p></td>
 
204
<td>The compared values are the same.
 
205
</td>
 
206
</tr>
 
207
<tr>
 
208
<td><p><a name="E-XMLHASH-STATUS-DIFFERENT:CAPS"></a><span class="term"><code class="literal">E_XMLHASH_STATUS_DIFFERENT</code></span></p></td>
 
209
<td>The compared values are different.
 
210
</td>
 
211
</tr>
 
212
<tr>
 
213
<td><p><a name="E-XMLHASH-STATUS-NOT-FOUND:CAPS"></a><span class="term"><code class="literal">E_XMLHASH_STATUS_NOT_FOUND</code></span></p></td>
 
214
<td>The key to compare against was not found.
 
215
</td>
 
216
</tr>
 
217
</tbody>
 
218
</table></div>
 
219
</div>
 
220
<hr>
 
221
<div class="refsect2" title="EXmlHashFunc ()">
 
222
<a name="EXmlHashFunc"></a><h3>EXmlHashFunc ()</h3>
 
223
<pre class="programlisting"><span class="returnvalue">void</span>                (*EXmlHashFunc)                     (<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
 
224
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>,
 
225
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
 
226
<p>
 
227
</p>
 
228
<div class="variablelist"><table border="0">
 
229
<col align="left" valign="top">
 
230
<tbody>
 
231
<tr>
 
232
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 
233
<td>
 
234
</td>
 
235
</tr>
 
236
<tr>
 
237
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 
238
<td>
 
239
</td>
 
240
</tr>
 
241
<tr>
 
242
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
243
<td>
 
244
</td>
 
245
</tr>
 
246
</tbody>
 
247
</table></div>
 
248
</div>
 
249
<hr>
 
250
<div class="refsect2" title="EXmlHashRemoveFunc ()">
 
251
<a name="EXmlHashRemoveFunc"></a><h3>EXmlHashRemoveFunc ()</h3>
 
252
<pre class="programlisting"><span class="returnvalue">gboolean</span>            (*EXmlHashRemoveFunc)               (<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
 
253
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>,
 
254
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
 
255
<p>
 
256
</p>
 
257
<div class="variablelist"><table border="0">
 
258
<col align="left" valign="top">
 
259
<tbody>
 
260
<tr>
 
261
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 
262
<td>
 
263
</td>
 
264
</tr>
 
265
<tr>
 
266
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 
267
<td>
 
268
</td>
 
269
</tr>
 
270
<tr>
 
271
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
272
<td>
 
273
</td>
 
274
</tr>
 
275
<tr>
 
276
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
277
<td>
 
278
</td>
 
279
</tr>
 
280
</tbody>
 
281
</table></div>
 
282
</div>
 
283
<hr>
 
284
<div class="refsect2" title="EXmlHash">
 
285
<a name="EXmlHash"></a><h3>EXmlHash</h3>
 
286
<pre class="programlisting">typedef struct EXmlHash EXmlHash;
 
287
</pre>
 
288
<p>
 
289
A hash table representation of an XML file.
 
290
</p>
 
291
</div>
 
292
<hr>
 
293
<div class="refsect2" title="e_xmlhash_new ()">
 
294
<a name="e-xmlhash-new"></a><h3>e_xmlhash_new ()</h3>
 
295
<pre class="programlisting"><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="returnvalue">EXmlHash</span></a> *          e_xmlhash_new                       (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
 
296
<p>
 
297
Creates a new <a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> from the file <em class="parameter"><code>filename</code></em>. If <em class="parameter"><code>filename</code></em> does
 
298
not already exist, an empty <a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> will be created.
 
299
</p>
 
300
<div class="variablelist"><table border="0">
 
301
<col align="left" valign="top">
 
302
<tbody>
 
303
<tr>
 
304
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
 
305
<td>The name of an XML file.
 
306
</td>
 
307
</tr>
 
308
<tr>
 
309
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
310
<td> The new <a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> structure, or <code class="literal">NULL</code> if unable to parse
 
311
         <em class="parameter"><code>filename</code></em>.
 
312
</td>
 
313
</tr>
 
314
</tbody>
 
315
</table></div>
 
316
</div>
 
317
<hr>
 
318
<div class="refsect2" title="e_xmlhash_add ()">
 
319
<a name="e-xmlhash-add"></a><h3>e_xmlhash_add ()</h3>
 
320
<pre class="programlisting"><span class="returnvalue">void</span>                e_xmlhash_add                       (<em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> *hash</code></em>,
 
321
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
 
322
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *data</code></em>);</pre>
 
323
<p>
 
324
Adds a new key/value pair to the <a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> <em class="parameter"><code>hash</code></em>.
 
325
</p>
 
326
<div class="variablelist"><table border="0">
 
327
<col align="left" valign="top">
 
328
<tbody>
 
329
<tr>
 
330
<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td>
 
331
<td>The <a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> to add an entry to.
 
332
</td>
 
333
</tr>
 
334
<tr>
 
335
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 
336
<td>The key to use for the entry.
 
337
</td>
 
338
</tr>
 
339
<tr>
 
340
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 
341
<td>The value of the new entry.
 
342
</td>
 
343
</tr>
 
344
</tbody>
 
345
</table></div>
 
346
</div>
 
347
<hr>
 
348
<div class="refsect2" title="e_xmlhash_remove ()">
 
349
<a name="e-xmlhash-remove"></a><h3>e_xmlhash_remove ()</h3>
 
350
<pre class="programlisting"><span class="returnvalue">void</span>                e_xmlhash_remove                    (<em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> *hash</code></em>,
 
351
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);</pre>
 
352
<p>
 
353
Remove the entry in <em class="parameter"><code>hash</code></em> with key equal to <em class="parameter"><code>key</code></em>, if it exists.
 
354
</p>
 
355
<div class="variablelist"><table border="0">
 
356
<col align="left" valign="top">
 
357
<tbody>
 
358
<tr>
 
359
<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td>
 
360
<td>The <a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> to remove an entry from.
 
361
</td>
 
362
</tr>
 
363
<tr>
 
364
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 
365
<td>The key of the entry to remove.
 
366
</td>
 
367
</tr>
 
368
</tbody>
 
369
</table></div>
 
370
</div>
 
371
<hr>
 
372
<div class="refsect2" title="e_xmlhash_compare ()">
 
373
<a name="e-xmlhash-compare"></a><h3>e_xmlhash_compare ()</h3>
 
374
<pre class="programlisting"><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHashStatus" title="enum EXmlHashStatus"><span class="returnvalue">EXmlHashStatus</span></a>      e_xmlhash_compare                   (<em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> *hash</code></em>,
 
375
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
 
376
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *compare_data</code></em>);</pre>
 
377
<p>
 
378
Compares the value with key equal to <em class="parameter"><code>key</code></em> in <em class="parameter"><code>hash</code></em> against
 
379
<em class="parameter"><code>compare_data</code></em>.
 
380
</p>
 
381
<div class="variablelist"><table border="0">
 
382
<col align="left" valign="top">
 
383
<tbody>
 
384
<tr>
 
385
<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td>
 
386
<td>The <a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> to compare against.
 
387
</td>
 
388
</tr>
 
389
<tr>
 
390
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 
391
<td>The key of the hash entry to compare with.
 
392
</td>
 
393
</tr>
 
394
<tr>
 
395
<td><p><span class="term"><em class="parameter"><code>compare_data</code></em> :</span></p></td>
 
396
<td>The data to compare against the hash entry.
 
397
</td>
 
398
</tr>
 
399
<tr>
 
400
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
401
<td> E_XMLHASH_STATUS_SAME if the value and <em class="parameter"><code>compare_data</code></em> are
 
402
         equal,E_XMLHASH_STATUS_DIFFERENT if they are different, or
 
403
         E_XMLHASH_STATUS_NOT_FOUND if there is no entry in <em class="parameter"><code>hash</code></em> with
 
404
         its key equal to <em class="parameter"><code>key</code></em>.
 
405
</td>
 
406
</tr>
 
407
</tbody>
 
408
</table></div>
 
409
</div>
 
410
<hr>
 
411
<div class="refsect2" title="e_xmlhash_foreach_key ()">
 
412
<a name="e-xmlhash-foreach-key"></a><h3>e_xmlhash_foreach_key ()</h3>
 
413
<pre class="programlisting"><span class="returnvalue">void</span>                e_xmlhash_foreach_key               (<em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> *hash</code></em>,
 
414
                                                         <em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHashFunc" title="EXmlHashFunc ()"><span class="type">EXmlHashFunc</span></a> func</code></em>,
 
415
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
 
416
<p>
 
417
Executes <em class="parameter"><code>func</code></em> against each key/value pair in <em class="parameter"><code>hash</code></em>.
 
418
</p>
 
419
<div class="variablelist"><table border="0">
 
420
<col align="left" valign="top">
 
421
<tbody>
 
422
<tr>
 
423
<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td>
 
424
<td>An <a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a>.
 
425
</td>
 
426
</tr>
 
427
<tr>
 
428
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
 
429
<td>The <a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHashFunc" title="EXmlHashFunc ()"><span class="type">EXmlHashFunc</span></a> to execute on the data in <em class="parameter"><code>hash</code></em>.
 
430
</td>
 
431
</tr>
 
432
<tr>
 
433
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
434
<td>The data to pass to <em class="parameter"><code>func</code></em>.
 
435
</td>
 
436
</tr>
 
437
</tbody>
 
438
</table></div>
 
439
</div>
 
440
<hr>
 
441
<div class="refsect2" title="e_xmlhash_foreach_key_remove ()">
 
442
<a name="e-xmlhash-foreach-key-remove"></a><h3>e_xmlhash_foreach_key_remove ()</h3>
 
443
<pre class="programlisting"><span class="returnvalue">void</span>                e_xmlhash_foreach_key_remove        (<em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> *hash</code></em>,
 
444
                                                         <em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHashRemoveFunc" title="EXmlHashRemoveFunc ()"><span class="type">EXmlHashRemoveFunc</span></a> func</code></em>,
 
445
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
 
446
<p>
 
447
</p>
 
448
<div class="variablelist"><table border="0">
 
449
<col align="left" valign="top">
 
450
<tbody>
 
451
<tr>
 
452
<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td>
 
453
<td>
 
454
</td>
 
455
</tr>
 
456
<tr>
 
457
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
 
458
<td>
 
459
</td>
 
460
</tr>
 
461
<tr>
 
462
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
463
<td>
 
464
</td>
 
465
</tr>
 
466
</tbody>
 
467
</table></div>
 
468
</div>
 
469
<hr>
 
470
<div class="refsect2" title="e_xmlhash_write ()">
 
471
<a name="e-xmlhash-write"></a><h3>e_xmlhash_write ()</h3>
 
472
<pre class="programlisting"><span class="returnvalue">void</span>                e_xmlhash_write                     (<em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> *hash</code></em>);</pre>
 
473
<p>
 
474
Writes the XML represented by <em class="parameter"><code>hash</code></em> to the file originally passed
 
475
to <a class="link" href="libedataserver-e-xml-hash-utils.html#e-xmlhash-new" title="e_xmlhash_new ()"><code class="function">e_xmlhash_new()</code></a>.
 
476
</p>
 
477
<div class="variablelist"><table border="0">
 
478
<col align="left" valign="top">
 
479
<tbody><tr>
 
480
<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td>
 
481
<td>The <a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> to write.
 
482
</td>
 
483
</tr></tbody>
 
484
</table></div>
 
485
</div>
 
486
<hr>
 
487
<div class="refsect2" title="e_xmlhash_destroy ()">
 
488
<a name="e-xmlhash-destroy"></a><h3>e_xmlhash_destroy ()</h3>
 
489
<pre class="programlisting"><span class="returnvalue">void</span>                e_xmlhash_destroy                   (<em class="parameter"><code><a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> *hash</code></em>);</pre>
 
490
<p>
 
491
Frees the memory associated with <em class="parameter"><code>hash</code></em>.
 
492
</p>
 
493
<div class="variablelist"><table border="0">
 
494
<col align="left" valign="top">
 
495
<tbody><tr>
 
496
<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td>
 
497
<td>The <a class="link" href="libedataserver-e-xml-hash-utils.html#EXmlHash" title="EXmlHash"><span class="type">EXmlHash</span></a> to destroy.
 
498
</td>
 
499
</tr></tbody>
 
500
</table></div>
 
501
</div>
 
502
</div>
 
503
</div>
 
504
<div class="footer">
 
505
<hr>
 
506
          Generated by GTK-Doc V1.14</div>
 
507
</body>
 
508
</html>
 
 
b'\\ No newline at end of file'