← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/camel/html/camel-CamelStoreSummary.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/camel/html/camel-CamelStoreSummary.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>CamelStoreSummary</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Camel Reference Manual">
8
8
<link rel="up" href="Services.html" title="Services">
9
9
<link rel="prev" href="camel-CamelStore.html" title="CamelStore">
26
26
                  <a href="#camel-CamelStoreSummary.description" class="shortcut">Description</a>
27
27
</td></tr>
28
28
</table>
29
 
<div class="refentry" lang="en">
 
29
<div class="refentry" title="CamelStoreSummary">
30
30
<a name="camel-CamelStoreSummary"></a><div class="titlepage"></div>
31
31
<div class="refnamediv"><table width="100%"><tr>
32
32
<td valign="top">
35
35
</td>
36
36
<td valign="top" align="right"></td>
37
37
</tr></table></div>
38
 
<div class="refsynopsisdiv">
 
38
<div class="refsynopsisdiv" title="Synopsis">
39
39
<a name="camel-CamelStoreSummary.synopsis"></a><h2>Synopsis</h2>
40
40
<pre class="synopsis">                    <a class="link" href="camel-CamelStoreSummary.html#CamelStoreInfo" title="CamelStoreInfo">CamelStoreInfo</a>;
41
41
enum                <a class="link" href="camel-CamelStoreSummary.html#CamelStoreInfoFlags" title="enum CamelStoreInfoFlags">CamelStoreInfoFlags</a>;
93
93
                                                         i)
94
94
</pre>
95
95
</div>
96
 
<div class="refsect1" lang="en">
 
96
<div class="refsect1" title="Description">
97
97
<a name="camel-CamelStoreSummary.description"></a><h2>Description</h2>
98
98
<p>
99
99
</p>
100
100
</div>
101
 
<div class="refsect1" lang="en">
 
101
<div class="refsect1" title="Details">
102
102
<a name="camel-CamelStoreSummary.details"></a><h2>Details</h2>
103
 
<div class="refsect2" lang="en">
 
103
<div class="refsect2" title="CamelStoreInfo">
104
104
<a name="CamelStoreInfo"></a><h3>CamelStoreInfo</h3>
105
105
<pre class="programlisting">typedef struct {
106
106
        guint32 refcount;
115
115
</p>
116
116
</div>
117
117
<hr>
118
 
<div class="refsect2" lang="en">
 
118
<div class="refsect2" title="enum CamelStoreInfoFlags">
119
119
<a name="CamelStoreInfoFlags"></a><h3>enum CamelStoreInfoFlags</h3>
120
120
<pre class="programlisting">typedef enum _CamelStoreInfoFlags {
121
121
        CAMEL_STORE_INFO_FOLDER_NOSELECT = 1&lt;&lt;0,
140
140
</p>
141
141
</div>
142
142
<hr>
143
 
<div class="refsect2" lang="en">
 
143
<div class="refsect2" title="CamelStoreSummary">
144
144
<a name="CamelStoreSummary"></a><h3>CamelStoreSummary</h3>
145
145
<pre class="programlisting">typedef struct {
146
146
        CamelObject parent;
170
170
</p>
171
171
</div>
172
172
<hr>
173
 
<div class="refsect2" lang="en">
 
173
<div class="refsect2" title="CAMEL_STORE_INFO_FOLDER_UNKNOWN">
174
174
<a name="CAMEL-STORE-INFO-FOLDER-UNKNOWN:CAPS"></a><h3>CAMEL_STORE_INFO_FOLDER_UNKNOWN</h3>
175
175
<pre class="programlisting">#define CAMEL_STORE_INFO_FOLDER_UNKNOWN (~0)
176
176
</pre>
178
178
</p>
179
179
</div>
180
180
<hr>
181
 
<div class="refsect2" lang="en">
 
181
<div class="refsect2" title="enum CamelStoreSummaryFlags">
182
182
<a name="CamelStoreSummaryFlags"></a><h3>enum CamelStoreSummaryFlags</h3>
183
183
<pre class="programlisting">typedef enum _CamelStoreSummaryFlags {
184
184
        CAMEL_STORE_SUMMARY_DIRTY = 1&lt;&lt;0,
189
189
</p>
190
190
</div>
191
191
<hr>
192
 
<div class="refsect2" lang="en">
 
192
<div class="refsect2" title="camel_store_summary_new ()">
193
193
<a name="camel-store-summary-new"></a><h3>camel_store_summary_new ()</h3>
194
194
<pre class="programlisting"><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="returnvalue">CamelStoreSummary</span></a> * camel_store_summary_new             (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
195
195
<p>
196
 
Create a new <a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> object.</p>
 
196
Create a new <a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> object.
 
197
</p>
197
198
<div class="variablelist"><table border="0">
198
199
<col align="left" valign="top">
199
200
<tbody><tr>
204
205
</table></div>
205
206
</div>
206
207
<hr>
207
 
<div class="refsect2" lang="en">
 
208
<div class="refsect2" title="camel_store_summary_set_filename ()">
208
209
<a name="camel-store-summary-set-filename"></a><h3>camel_store_summary_set_filename ()</h3>
209
210
<pre class="programlisting"><span class="returnvalue">void</span>                camel_store_summary_set_filename    (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>,
210
211
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
211
212
<p>
212
 
Set the filename where the summary will be loaded to/saved from.</p>
 
213
Set the filename where the summary will be loaded to/saved from.
 
214
</p>
213
215
<div class="variablelist"><table border="0">
214
216
<col align="left" valign="top">
215
217
<tbody>
227
229
</table></div>
228
230
</div>
229
231
<hr>
230
 
<div class="refsect2" lang="en">
 
232
<div class="refsect2" title="camel_store_summary_set_uri_base ()">
231
233
<a name="camel-store-summary-set-uri-base"></a><h3>camel_store_summary_set_uri_base ()</h3>
232
234
<pre class="programlisting"><span class="returnvalue">void</span>                camel_store_summary_set_uri_base    (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>,
233
235
                                                         <em class="parameter"><code><a class="link" href="camel-camel-url.html#CamelURL" title="CamelURL"><span class="type">CamelURL</span></a> *base</code></em>);</pre>
234
236
<p>
235
 
Sets the base URI for the summary.</p>
 
237
Sets the base URI for the summary.
 
238
</p>
236
239
<div class="variablelist"><table border="0">
237
240
<col align="left" valign="top">
238
241
<tbody>
250
253
</table></div>
251
254
</div>
252
255
<hr>
253
 
<div class="refsect2" lang="en">
 
256
<div class="refsect2" title="camel_store_summary_load ()">
254
257
<a name="camel-store-summary-load"></a><h3>camel_store_summary_load ()</h3>
255
258
<pre class="programlisting"><span class="returnvalue">gint</span>                camel_store_summary_load            (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>);</pre>
256
259
<p>
257
 
Load the summary off disk.</p>
 
260
Load the summary off disk.
 
261
</p>
258
262
<div class="variablelist"><table border="0">
259
263
<col align="left" valign="top">
260
264
<tbody>
272
276
</table></div>
273
277
</div>
274
278
<hr>
275
 
<div class="refsect2" lang="en">
 
279
<div class="refsect2" title="camel_store_summary_save ()">
276
280
<a name="camel-store-summary-save"></a><h3>camel_store_summary_save ()</h3>
277
281
<pre class="programlisting"><span class="returnvalue">gint</span>                camel_store_summary_save            (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>);</pre>
278
282
<p>
279
283
Writes the summary to disk.  The summary is only written if changes
280
 
have occured.</p>
 
284
have occured.
 
285
</p>
281
286
<div class="variablelist"><table border="0">
282
287
<col align="left" valign="top">
283
288
<tbody>
295
300
</table></div>
296
301
</div>
297
302
<hr>
298
 
<div class="refsect2" lang="en">
 
303
<div class="refsect2" title="camel_store_summary_header_load ()">
299
304
<a name="camel-store-summary-header-load"></a><h3>camel_store_summary_header_load ()</h3>
300
305
<pre class="programlisting"><span class="returnvalue">gint</span>                camel_store_summary_header_load     (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>);</pre>
301
306
<p>
302
307
Only load the header information from the summary,
303
308
keep the rest on disk.  This should only be done on
304
 
a fresh summary object.</p>
 
309
a fresh summary object.
 
310
</p>
305
311
<div class="variablelist"><table border="0">
306
312
<col align="left" valign="top">
307
313
<tbody>
319
325
</table></div>
320
326
</div>
321
327
<hr>
322
 
<div class="refsect2" lang="en">
 
328
<div class="refsect2" title="camel_store_summary_touch ()">
323
329
<a name="camel-store-summary-touch"></a><h3>camel_store_summary_touch ()</h3>
324
330
<pre class="programlisting"><span class="returnvalue">void</span>                camel_store_summary_touch           (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>);</pre>
325
331
<p>
326
332
Mark the summary as changed, so that a save will force it to be
327
 
written back to disk.</p>
 
333
written back to disk.
 
334
</p>
328
335
<div class="variablelist"><table border="0">
329
336
<col align="left" valign="top">
330
337
<tbody><tr>
335
342
</table></div>
336
343
</div>
337
344
<hr>
338
 
<div class="refsect2" lang="en">
 
345
<div class="refsect2" title="camel_store_summary_add ()">
339
346
<a name="camel-store-summary-add"></a><h3>camel_store_summary_add ()</h3>
340
347
<pre class="programlisting"><span class="returnvalue">void</span>                camel_store_summary_add             (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>,
341
348
                                                         <em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreInfo" title="CamelStoreInfo"><span class="type">CamelStoreInfo</span></a> *info</code></em>);</pre>
347
354
<p>
348
355
The <em class="parameter"><code>info</code></em> record should have been generated by calling one of the
349
356
info_new_*() functions, as it will be free'd based on the summary
350
 
class.  And MUST NOT be allocated directly using malloc.</p>
 
357
class.  And MUST NOT be allocated directly using malloc.
 
358
</p>
351
359
<div class="variablelist"><table border="0">
352
360
<col align="left" valign="top">
353
361
<tbody>
365
373
</table></div>
366
374
</div>
367
375
<hr>
368
 
<div class="refsect2" lang="en">
 
376
<div class="refsect2" title="camel_store_summary_add_from_path ()">
369
377
<a name="camel-store-summary-add-from-path"></a><h3>camel_store_summary_add_from_path ()</h3>
370
378
<pre class="programlisting"><a class="link" href="camel-CamelStoreSummary.html#CamelStoreInfo" title="CamelStoreInfo"><span class="returnvalue">CamelStoreInfo</span></a> *    camel_store_summary_add_from_path   (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>,
371
379
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>);</pre>
372
380
<p>
373
 
Build a new info record based on the name, and add it to the summary.</p>
 
381
Build a new info record based on the name, and add it to the summary.
 
382
</p>
374
383
<div class="variablelist"><table border="0">
375
384
<col align="left" valign="top">
376
385
<tbody>
393
402
</table></div>
394
403
</div>
395
404
<hr>
396
 
<div class="refsect2" lang="en">
 
405
<div class="refsect2" title="camel_store_summary_info_new ()">
397
406
<a name="camel-store-summary-info-new"></a><h3>camel_store_summary_info_new ()</h3>
398
407
<pre class="programlisting"><a class="link" href="camel-CamelStoreSummary.html#CamelStoreInfo" title="CamelStoreInfo"><span class="returnvalue">CamelStoreInfo</span></a> *    camel_store_summary_info_new        (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>);</pre>
399
408
<p>
400
409
Allocate a new <a class="link" href="camel-CamelStoreSummary.html#CamelStoreInfo" title="CamelStoreInfo"><span class="type">CamelStoreInfo</span></a>, suitable for adding to this
401
 
summary.</p>
 
410
summary.
 
411
</p>
402
412
<div class="variablelist"><table border="0">
403
413
<col align="left" valign="top">
404
414
<tbody>
416
426
</table></div>
417
427
</div>
418
428
<hr>
419
 
<div class="refsect2" lang="en">
 
429
<div class="refsect2" title="camel_store_summary_info_new_from_path ()">
420
430
<a name="camel-store-summary-info-new-from-path"></a><h3>camel_store_summary_info_new_from_path ()</h3>
421
431
<pre class="programlisting"><a class="link" href="camel-CamelStoreSummary.html#CamelStoreInfo" title="CamelStoreInfo"><span class="returnvalue">CamelStoreInfo</span></a> *    camel_store_summary_info_new_from_path
422
432
                                                        (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>,
427
437
<p>
428
438
This info record MUST be freed using
429
439
<a class="link" href="camel-CamelStoreSummary.html#camel-store-summary-info-free" title="camel_store_summary_info_free ()"><span class="type">camel_store_summary_info_free</span></a>, <span class="type">camel_store_info_free</span> will not
430
 
work.</p>
 
440
work.
 
441
</p>
431
442
<div class="variablelist"><table border="0">
432
443
<col align="left" valign="top">
433
444
<tbody>
450
461
</table></div>
451
462
</div>
452
463
<hr>
453
 
<div class="refsect2" lang="en">
 
464
<div class="refsect2" title="camel_store_summary_info_ref ()">
454
465
<a name="camel-store-summary-info-ref"></a><h3>camel_store_summary_info_ref ()</h3>
455
466
<pre class="programlisting"><span class="returnvalue">void</span>                camel_store_summary_info_ref        (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>,
456
467
                                                         <em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreInfo" title="CamelStoreInfo"><span class="type">CamelStoreInfo</span></a> *info</code></em>);</pre>
457
468
<p>
458
 
Add an extra reference to <em class="parameter"><code>info</code></em>.</p>
 
469
Add an extra reference to <em class="parameter"><code>info</code></em>.
 
470
</p>
459
471
<div class="variablelist"><table border="0">
460
472
<col align="left" valign="top">
461
473
<tbody>
473
485
</table></div>
474
486
</div>
475
487
<hr>
476
 
<div class="refsect2" lang="en">
 
488
<div class="refsect2" title="camel_store_summary_info_free ()">
477
489
<a name="camel-store-summary-info-free"></a><h3>camel_store_summary_info_free ()</h3>
478
490
<pre class="programlisting"><span class="returnvalue">void</span>                camel_store_summary_info_free       (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>,
479
491
                                                         <em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreInfo" title="CamelStoreInfo"><span class="type">CamelStoreInfo</span></a> *info</code></em>);</pre>
480
492
<p>
481
 
Unref and potentially free <em class="parameter"><code>info</code></em>, and all associated memory.</p>
 
493
Unref and potentially free <em class="parameter"><code>info</code></em>, and all associated memory.
 
494
</p>
482
495
<div class="variablelist"><table border="0">
483
496
<col align="left" valign="top">
484
497
<tbody>
496
509
</table></div>
497
510
</div>
498
511
<hr>
499
 
<div class="refsect2" lang="en">
 
512
<div class="refsect2" title="camel_store_summary_remove ()">
500
513
<a name="camel-store-summary-remove"></a><h3>camel_store_summary_remove ()</h3>
501
514
<pre class="programlisting"><span class="returnvalue">void</span>                camel_store_summary_remove          (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>,
502
515
                                                         <em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreInfo" title="CamelStoreInfo"><span class="type">CamelStoreInfo</span></a> *info</code></em>);</pre>
503
516
<p>
504
 
Remove a specific <em class="parameter"><code>info</code></em> record from the summary.</p>
 
517
Remove a specific <em class="parameter"><code>info</code></em> record from the summary.
 
518
</p>
505
519
<div class="variablelist"><table border="0">
506
520
<col align="left" valign="top">
507
521
<tbody>
519
533
</table></div>
520
534
</div>
521
535
<hr>
522
 
<div class="refsect2" lang="en">
 
536
<div class="refsect2" title="camel_store_summary_remove_path ()">
523
537
<a name="camel-store-summary-remove-path"></a><h3>camel_store_summary_remove_path ()</h3>
524
538
<pre class="programlisting"><span class="returnvalue">void</span>                camel_store_summary_remove_path     (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>,
525
539
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>);</pre>
526
540
<p>
527
 
Remove a specific info record from the summary, by <em class="parameter"><code>path</code></em>.</p>
 
541
Remove a specific info record from the summary, by <em class="parameter"><code>path</code></em>.
 
542
</p>
528
543
<div class="variablelist"><table border="0">
529
544
<col align="left" valign="top">
530
545
<tbody>
542
557
</table></div>
543
558
</div>
544
559
<hr>
545
 
<div class="refsect2" lang="en">
 
560
<div class="refsect2" title="camel_store_summary_remove_index ()">
546
561
<a name="camel-store-summary-remove-index"></a><h3>camel_store_summary_remove_index ()</h3>
547
562
<pre class="programlisting"><span class="returnvalue">void</span>                camel_store_summary_remove_index    (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>,
548
563
                                                         <em class="parameter"><code><span class="type">gint</span> index</code></em>);</pre>
549
564
<p>
550
 
Remove a specific info record from the summary, by index.</p>
 
565
Remove a specific info record from the summary, by index.
 
566
</p>
551
567
<div class="variablelist"><table border="0">
552
568
<col align="left" valign="top">
553
569
<tbody>
565
581
</table></div>
566
582
</div>
567
583
<hr>
568
 
<div class="refsect2" lang="en">
 
584
<div class="refsect2" title="camel_store_summary_clear ()">
569
585
<a name="camel-store-summary-clear"></a><h3>camel_store_summary_clear ()</h3>
570
586
<pre class="programlisting"><span class="returnvalue">void</span>                camel_store_summary_clear           (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>);</pre>
571
587
<p>
572
 
Empty the summary contents.</p>
 
588
Empty the summary contents.
 
589
</p>
573
590
<div class="variablelist"><table border="0">
574
591
<col align="left" valign="top">
575
592
<tbody><tr>
580
597
</table></div>
581
598
</div>
582
599
<hr>
583
 
<div class="refsect2" lang="en">
 
600
<div class="refsect2" title="camel_store_summary_count ()">
584
601
<a name="camel-store-summary-count"></a><h3>camel_store_summary_count ()</h3>
585
602
<pre class="programlisting"><span class="returnvalue">gint</span>                camel_store_summary_count           (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>);</pre>
586
603
<p>
587
 
Get the number of summary items stored in this summary.</p>
 
604
Get the number of summary items stored in this summary.
 
605
</p>
588
606
<div class="variablelist"><table border="0">
589
607
<col align="left" valign="top">
590
608
<tbody>
602
620
</table></div>
603
621
</div>
604
622
<hr>
605
 
<div class="refsect2" lang="en">
 
623
<div class="refsect2" title="camel_store_summary_index ()">
606
624
<a name="camel-store-summary-index"></a><h3>camel_store_summary_index ()</h3>
607
625
<pre class="programlisting"><a class="link" href="camel-CamelStoreSummary.html#CamelStoreInfo" title="CamelStoreInfo"><span class="returnvalue">CamelStoreInfo</span></a> *    camel_store_summary_index           (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>,
608
626
                                                         <em class="parameter"><code><span class="type">gint</span> index</code></em>);</pre>
614
632
free'd as appropriate.
615
633
</p>
616
634
<p>
617
 
It must be freed using <a class="link" href="camel-CamelStoreSummary.html#camel-store-summary-info-free" title="camel_store_summary_info_free ()"><span class="type">camel_store_summary_info_free</span></a>.</p>
 
635
It must be freed using <a class="link" href="camel-CamelStoreSummary.html#camel-store-summary-info-free" title="camel_store_summary_info_free ()"><span class="type">camel_store_summary_info_free</span></a>.
 
636
</p>
618
637
<div class="variablelist"><table border="0">
619
638
<col align="left" valign="top">
620
639
<tbody>
637
656
</table></div>
638
657
</div>
639
658
<hr>
640
 
<div class="refsect2" lang="en">
 
659
<div class="refsect2" title="camel_store_summary_path ()">
641
660
<a name="camel-store-summary-path"></a><h3>camel_store_summary_path ()</h3>
642
661
<pre class="programlisting"><a class="link" href="camel-CamelStoreSummary.html#CamelStoreInfo" title="CamelStoreInfo"><span class="returnvalue">CamelStoreInfo</span></a> *    camel_store_summary_path            (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>,
643
662
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>);</pre>
649
668
free'd as appropriate.
650
669
</p>
651
670
<p>
652
 
It must be freed using <a class="link" href="camel-CamelStoreSummary.html#camel-store-summary-info-free" title="camel_store_summary_info_free ()"><span class="type">camel_store_summary_info_free</span></a>.</p>
 
671
It must be freed using <a class="link" href="camel-CamelStoreSummary.html#camel-store-summary-info-free" title="camel_store_summary_info_free ()"><span class="type">camel_store_summary_info_free</span></a>.
 
672
</p>
653
673
<div class="variablelist"><table border="0">
654
674
<col align="left" valign="top">
655
675
<tbody>
673
693
</table></div>
674
694
</div>
675
695
<hr>
676
 
<div class="refsect2" lang="en">
 
696
<div class="refsect2" title="camel_store_summary_array ()">
677
697
<a name="camel-store-summary-array"></a><h3>camel_store_summary_array ()</h3>
678
698
<pre class="programlisting"><span class="returnvalue">GPtrArray</span> *         camel_store_summary_array           (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>);</pre>
679
699
<p>
681
701
so cannot contain empty entries.
682
702
</p>
683
703
<p>
684
 
It must be freed using <a class="link" href="camel-CamelStoreSummary.html#camel-store-summary-array-free" title="camel_store_summary_array_free ()"><span class="type">camel_store_summary_array_free</span></a>.</p>
 
704
It must be freed using <a class="link" href="camel-CamelStoreSummary.html#camel-store-summary-array-free" title="camel_store_summary_array_free ()"><span class="type">camel_store_summary_array_free</span></a>.
 
705
</p>
685
706
<div class="variablelist"><table border="0">
686
707
<col align="left" valign="top">
687
708
<tbody>
699
720
</table></div>
700
721
</div>
701
722
<hr>
702
 
<div class="refsect2" lang="en">
 
723
<div class="refsect2" title="camel_store_summary_array_free ()">
703
724
<a name="camel-store-summary-array-free"></a><h3>camel_store_summary_array_free ()</h3>
704
725
<pre class="programlisting"><span class="returnvalue">void</span>                camel_store_summary_array_free      (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>,
705
726
                                                         <em class="parameter"><code><span class="type">GPtrArray</span> *array</code></em>);</pre>
706
727
<p>
707
 
Free the folder summary array.</p>
 
728
Free the folder summary array.
 
729
</p>
708
730
<div class="variablelist"><table border="0">
709
731
<col align="left" valign="top">
710
732
<tbody>
722
744
</table></div>
723
745
</div>
724
746
<hr>
725
 
<div class="refsect2" lang="en">
 
747
<div class="refsect2" title="camel_store_info_string ()">
726
748
<a name="camel-store-info-string"></a><h3>camel_store_info_string ()</h3>
727
749
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       camel_store_info_string             (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>,
728
750
                                                         <em class="parameter"><code>const <a class="link" href="camel-CamelStoreSummary.html#CamelStoreInfo" title="CamelStoreInfo"><span class="type">CamelStoreInfo</span></a> *info</code></em>,
729
751
                                                         <em class="parameter"><code><span class="type">gint</span> type</code></em>);</pre>
730
752
<p>
731
 
Get a specific string from the <em class="parameter"><code>info</code></em>.</p>
 
753
Get a specific string from the <em class="parameter"><code>info</code></em>.
 
754
</p>
732
755
<div class="variablelist"><table border="0">
733
756
<col align="left" valign="top">
734
757
<tbody>
756
779
</table></div>
757
780
</div>
758
781
<hr>
759
 
<div class="refsect2" lang="en">
 
782
<div class="refsect2" title="camel_store_info_set_string ()">
760
783
<a name="camel-store-info-set-string"></a><h3>camel_store_info_set_string ()</h3>
761
784
<pre class="programlisting"><span class="returnvalue">void</span>                camel_store_info_set_string         (<em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreSummary" title="CamelStoreSummary"><span class="type">CamelStoreSummary</span></a> *summary</code></em>,
762
785
                                                         <em class="parameter"><code><a class="link" href="camel-CamelStoreSummary.html#CamelStoreInfo" title="CamelStoreInfo"><span class="type">CamelStoreInfo</span></a> *info</code></em>,
763
786
                                                         <em class="parameter"><code><span class="type">gint</span> type</code></em>,
764
787
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>);</pre>
765
788
<p>
766
 
Set a specific string on the <em class="parameter"><code>info</code></em>.</p>
 
789
Set a specific string on the <em class="parameter"><code>info</code></em>.
 
790
</p>
767
791
<div class="variablelist"><table border="0">
768
792
<col align="left" valign="top">
769
793
<tbody>
791
815
</table></div>
792
816
</div>
793
817
<hr>
794
 
<div class="refsect2" lang="en">
 
818
<div class="refsect2" title="camel_store_info_path()">
795
819
<a name="camel-store-info-path"></a><h3>camel_store_info_path()</h3>
796
820
<pre class="programlisting">#define camel_store_info_path(s, i) (camel_store_info_string((CamelStoreSummary *)s, (const CamelStoreInfo *)i, CAMEL_STORE_INFO_PATH))
797
821
</pre>
814
838
</table></div>
815
839
</div>
816
840
<hr>
817
 
<div class="refsect2" lang="en">
 
841
<div class="refsect2" title="camel_store_info_uri()">
818
842
<a name="camel-store-info-uri"></a><h3>camel_store_info_uri()</h3>
819
843
<pre class="programlisting">#define camel_store_info_uri(s, i) (camel_store_info_string((CamelStoreSummary *)s, (const CamelStoreInfo *)i, CAMEL_STORE_INFO_URI))
820
844
</pre>
837
861
</table></div>
838
862
</div>
839
863
<hr>
840
 
<div class="refsect2" lang="en">
 
864
<div class="refsect2" title="camel_store_info_name()">
841
865
<a name="camel-store-info-name"></a><h3>camel_store_info_name()</h3>
842
866
<pre class="programlisting">#define camel_store_info_name(s, i) (camel_store_info_string((CamelStoreSummary *)s, (const CamelStoreInfo *)i, CAMEL_STORE_INFO_NAME))
843
867
</pre>