libgmime-3.0-doc 3.2.0-1 / usr / share / gtk-doc / html / gmime-3.2 / gmime-GMimePartIter.html

This file is indexed.

/usr/share/gtk-doc/html/gmime-3.2/gmime-GMimePartIter.html is in libgmime-3.0-doc 3.2.0-1.

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
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GMimePartIter: GMime 3.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GMime 3.0 Reference Manual">
<link rel="up" href="MimeParts.html" title="MIME Messages and Parts">
<link rel="prev" href="GMimeMessagePartial.html" title="GMimeMessagePartial">
<link rel="next" href="Parsers.html" title="Parsing Messages and MIME Parts">
<meta name="generator" content="GTK-Doc V1.25 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gmime-GMimePartIter.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="MimeParts.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GMimeMessagePartial.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="Parsers.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gmime-GMimePartIter"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gmime-GMimePartIter.top_of_page"></a>GMimePartIter</span></h2>
<p>GMimePartIter — MIME part iterators</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gmime-GMimePartIter.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="returnvalue">GMimePartIter</span></a> *
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-new" title="g_mime_part_iter_new ()">g_mime_part_iter_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-free" title="g_mime_part_iter_free ()">g_mime_part_iter_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="returnvalue">GMimePartIter</span></a> *
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-clone" title="g_mime_part_iter_clone ()">g_mime_part_iter_clone</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-reset" title="g_mime_part_iter_reset ()">g_mime_part_iter_reset</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-jump-to" title="g_mime_part_iter_jump_to ()">g_mime_part_iter_jump_to</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-is-valid" title="g_mime_part_iter_is_valid ()">g_mime_part_iter_is_valid</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-next" title="g_mime_part_iter_next ()">g_mime_part_iter_next</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-prev" title="g_mime_part_iter_prev ()">g_mime_part_iter_prev</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-get-toplevel" title="g_mime_part_iter_get_toplevel ()">g_mime_part_iter_get_toplevel</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-get-current" title="g_mime_part_iter_get_current ()">g_mime_part_iter_get_current</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-get-parent" title="g_mime_part_iter_get_parent ()">g_mime_part_iter_get_parent</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-get-path" title="g_mime_part_iter_get_path ()">g_mime_part_iter_get_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-replace" title="g_mime_part_iter_replace ()">g_mime_part_iter_replace</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-remove" title="g_mime_part_iter_remove ()">g_mime_part_iter_remove</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gmime-GMimePartIter.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter">GMimePartIter</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gmime-GMimePartIter.description"></a><h2>Description</h2>
<p><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> is an iterator for traversing a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> tree in
Depth-First order.</p>
</div>
<div class="refsect1">
<a name="gmime-GMimePartIter.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="g-mime-part-iter-new"></a><h3>g_mime_part_iter_new ()</h3>
<pre class="programlisting"><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="returnvalue">GMimePartIter</span></a> *
g_mime_part_iter_new (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *toplevel</code></em>);</pre>
<p>Creates a new <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> for iterating over <em class="parameter"><code>toplevel</code></em>
's subparts.</p>
<div class="refsect3">
<a name="g-mime-part-iter-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>toplevel</p></td>
<td class="parameter_description"><p>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> to use as the toplevel</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-new.returns"></a><h4>Returns</h4>
<p> a newly allocated <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> which should be freed
using <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-free" title="g_mime_part_iter_free ()"><code class="function">g_mime_part_iter_free()</code></a> when finished with it.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-free"></a><h3>g_mime_part_iter_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_part_iter_free (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Frees the memory allocated by <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-new" title="g_mime_part_iter_new ()"><code class="function">g_mime_part_iter_new()</code></a>.</p>
<div class="refsect3">
<a name="g-mime-part-iter-free.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-clone"></a><h3>g_mime_part_iter_clone ()</h3>
<pre class="programlisting"><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="returnvalue">GMimePartIter</span></a> *
g_mime_part_iter_clone (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Clones the <em class="parameter"><code>iter</code></em>
, including its current state.</p>
<div class="refsect3">
<a name="g-mime-part-iter-clone.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-clone.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> that is identical to <em class="parameter"><code>iter</code></em>
. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-reset"></a><h3>g_mime_part_iter_reset ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_part_iter_reset (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Resets the state of <em class="parameter"><code>iter</code></em>
 to its initial state.</p>
<div class="refsect3">
<a name="g-mime-part-iter-reset.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-jump-to"></a><h3>g_mime_part_iter_jump_to ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
g_mime_part_iter_jump_to (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>,
                          <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre>
<p>Updates the state of <em class="parameter"><code>iter</code></em>
 to point to the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> specified
by <em class="parameter"><code>path</code></em>
.</p>
<div class="refsect3">
<a name="g-mime-part-iter-jump-to.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a string representing the path to jump to</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-jump-to.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> specified by <em class="parameter"><code>path</code></em>
exists or
<code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-is-valid"></a><h3>g_mime_part_iter_is_valid ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
g_mime_part_iter_is_valid (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Checks that the current state of <em class="parameter"><code>iter</code></em>
 is valid.</p>
<div class="refsect3">
<a name="g-mime-part-iter-is-valid.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-is-valid.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>iter</code></em>
is valid or <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-next"></a><h3>g_mime_part_iter_next ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
g_mime_part_iter_next (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Advances to the next part in the MIME structure used to initialize
<em class="parameter"><code>iter</code></em>
.</p>
<div class="refsect3">
<a name="g-mime-part-iter-next.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-next.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if successful or <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-prev"></a><h3>g_mime_part_iter_prev ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
g_mime_part_iter_prev (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Rewinds to the previous part in the MIME structure used to
initialize <em class="parameter"><code>iter</code></em>
.</p>
<div class="refsect3">
<a name="g-mime-part-iter-prev.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-prev.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if successful or <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-get-toplevel"></a><h3>g_mime_part_iter_get_toplevel ()</h3>
<pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *
g_mime_part_iter_get_toplevel (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Gets the toplevel <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> used to initialize <em class="parameter"><code>iter</code></em>
.</p>
<div class="refsect3">
<a name="g-mime-part-iter-get-toplevel.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-get-toplevel.returns"></a><h4>Returns</h4>
<p> the toplevel <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-get-current"></a><h3>g_mime_part_iter_get_current ()</h3>
<pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *
g_mime_part_iter_get_current (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Gets the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> at the current <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> position.</p>
<div class="refsect3">
<a name="g-mime-part-iter-get-current.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-get-current.returns"></a><h4>Returns</h4>
<p> the current <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> or <code class="literal">NULL</code> if the
state of <em class="parameter"><code>iter</code></em>
is invalid. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-get-parent"></a><h3>g_mime_part_iter_get_parent ()</h3>
<pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *
g_mime_part_iter_get_parent (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Gets the parent of the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> at the current <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a>
position.</p>
<div class="refsect3">
<a name="g-mime-part-iter-get-parent.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-get-parent.returns"></a><h4>Returns</h4>
<p> the parent <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> or <code class="literal">NULL</code> if the
state of <em class="parameter"><code>iter</code></em>
is invalid. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-get-path"></a><h3>g_mime_part_iter_get_path ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *
g_mime_part_iter_get_path (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Gets the path of the current <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> in the MIME structure
used to initialize <em class="parameter"><code>iter</code></em>
.</p>
<div class="refsect3">
<a name="g-mime-part-iter-get-path.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-get-path.returns"></a><h4>Returns</h4>
<p> a newly allocated string representation of the path to the
<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> at the current <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> position.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-replace"></a><h3>g_mime_part_iter_replace ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
g_mime_part_iter_replace (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>,
                          <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *replacement</code></em>);</pre>
<p>Replaces the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> at the current position with <em class="parameter"><code>replacement</code></em>
.</p>
<div class="refsect3">
<a name="g-mime-part-iter-replace.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>replacement</p></td>
<td class="parameter_description"><p>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-replace.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the part at the current position was replaced or
<code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-part-iter-remove"></a><h3>g_mime_part_iter_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
g_mime_part_iter_remove (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre>
<p>Removes the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> at the current position from its
parent. If successful, <em class="parameter"><code>iter</code></em>
 is advanced to the next position
(since the current position will become invalid).</p>
<div class="refsect3">
<a name="g-mime-part-iter-remove.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-part-iter-remove.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the part at the current position was removed or
<code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="gmime-GMimePartIter.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GMimePartIter"></a><h3>GMimePartIter</h3>
<pre class="programlisting">typedef struct _GMimePartIter GMimePartIter;</pre>
<p>A MIME part iterator.</p>
</div>
</div>
<div class="refsect1">
<a name="gmime-GMimePartIter.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.