diff options
Diffstat (limited to 'docs/reference/html/gmime-GMimePartIter.html')
| -rw-r--r-- | docs/reference/html/gmime-GMimePartIter.html | 388 |
1 files changed, 388 insertions, 0 deletions
diff --git a/docs/reference/html/gmime-GMimePartIter.html b/docs/reference/html/gmime-GMimePartIter.html new file mode 100644 index 0000000..3e949c6 --- /dev/null +++ b/docs/reference/html/gmime-GMimePartIter.html @@ -0,0 +1,388 @@ +<!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</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 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.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="GMimeMessagePartial.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="MimeParts.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">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="Parsers.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#gmime-GMimePartIter.synopsis" class="shortcut">Top</a> + | + <a href="#gmime-GMimePartIter.description" class="shortcut">Description</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 valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gmime-GMimePartIter.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter">GMimePartIter</a>; +<a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="returnvalue">GMimePartIter</span></a> * <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-new" title="g_mime_part_iter_new ()">g_mime_part_iter_new</a> (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *toplevel</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-free" title="g_mime_part_iter_free ()">g_mime_part_iter_free</a> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-reset" title="g_mime_part_iter_reset ()">g_mime_part_iter_reset</a> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>); +<span class="returnvalue">gboolean</span> <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> (<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>); +<span class="returnvalue">gboolean</span> <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> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-next" title="g_mime_part_iter_next ()">g_mime_part_iter_next</a> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-prev" title="g_mime_part_iter_prev ()">g_mime_part_iter_prev</a> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>); +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * <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> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>); +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * <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> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>); +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * <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> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>); +<span class="returnvalue">char</span> * <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> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-replace" title="g_mime_part_iter_replace ()">g_mime_part_iter_replace</a> (<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>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-remove" title="g_mime_part_iter_remove ()">g_mime_part_iter_remove</a> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>); +</pre> +</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.details"></a><h2>Details</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> +<hr> +<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="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>toplevel</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> to use as the toplevel</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>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.</td> +</tr> +</tbody> +</table></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="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</tr></tbody> +</table></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="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</tr></tbody> +</table></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="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td> +<td>a string representing the path to jump to</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<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.</td> +</tr> +</tbody> +</table></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="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if <em class="parameter"><code>iter</code></em> is valid or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></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="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if successful or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></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="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if successful or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></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="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the toplevel <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>.</td> +</tr> +</tbody> +</table></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="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>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.</td> +</tr> +</tbody> +</table></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="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>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.</td> +</tr> +</tbody> +</table></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="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>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.</td> +</tr> +</tbody> +</table></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="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>replacement</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the part at the current position was replaced or +<code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></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="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the part at the current position was removed or +<code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="gmime-GMimePartIter.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file |