← Back to branch summary

~ubuntu-branches/ubuntu/breezy/evolution-data-server/breezy

« 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): Daniel Holbach
  • Date: 2005-10-10 11:30:56 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20051010113056-rb4vj4kbs8yxft85
Tags: 1.4.1-0ubuntu3
* debian/patches/camel-imap-store.c.patch:
  - Ubuntu 17465: apply patch from
  http://bugzilla.gnome.org/attachment.cgi?id=53234&action=view
  (additional NULL pointer check)

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