libedataserver1.2-dev 3.2.3-0ubuntu6 / usr / share / gtk-doc / html / libedataserver / libedataserver-e-xml-hash-utils.html

This file is indexed.

/usr/share/gtk-doc/html/libedataserver/libedataserver-e-xml-hash-utils.html is in libedataserver1.2-dev 3.2.3-0ubuntu6.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

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

APT Browse - Built by Thomas Orozco.