docs/reference/html/gmime-GMimePartIter.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GMimePartIter</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GMime 2.6 Reference Manual">
   8 <link rel="up" href="MimeParts.html" title="MIME Messages and Parts">
   9 <link rel="prev" href="GMimeMessagePartial.html" title="GMimeMessagePartial">
  10 <link rel="next" href="Parsers.html" title="Parsing Messages and MIME Parts">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="GMimeMessagePartial.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="MimeParts.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GMime 2.6 Reference Manual</th>
  21 <td><a accesskey="n" href="Parsers.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gmime-GMimePartIter.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gmime-GMimePartIter.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gmime-GMimePartIter"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gmime-GMimePartIter.top_of_page"></a>GMimePartIter</span></h2>
  34 <p>GMimePartIter — MIME part iterators</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gmime-GMimePartIter.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">                    <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter">GMimePartIter</a>;
  41 <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>);
  42 <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>);
  43 <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>);
  44 <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>,
  45                                                          <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);
  46 <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>);
  47 <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>);
  48 <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>);
  49 <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>);
  50 <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>);
  51 <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>);
  52 <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>);
  53 <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>,
  54                                                          <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *replacement</code></em>);
  55 <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>);
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="gmime-GMimePartIter.description"></a><h2>Description</h2>
  60 <p>
  61 <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
  62 Depth-First order.
  63 </p>
  64 </div>
  65 <div class="refsect1">
  66 <a name="gmime-GMimePartIter.details"></a><h2>Details</h2>
  67 <div class="refsect2">
  68 <a name="GMimePartIter"></a><h3>GMimePartIter</h3>
  69 <pre class="programlisting">typedef struct _GMimePartIter GMimePartIter;</pre>
  70 <p>
  71 A MIME part iterator.
  72 </p>
  73 </div>
  74 <hr>
  75 <div class="refsect2">
  76 <a name="g-mime-part-iter-new"></a><h3>g_mime_part_iter_new ()</h3>
  77 <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>
  78 <p>
  79 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.
  80 </p>
  81 <div class="variablelist"><table border="0">
  82 <col align="left" valign="top">
  83 <tbody>
  84 <tr>
  85 <td><p><span class="term"><em class="parameter"><code>toplevel</code></em> :</span></p></td>
  86 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> to use as the toplevel</td>
  87 </tr>
  88 <tr>
  89 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  90 <td>a newly allocated <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> which should be freed
  91 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>
  92 </tr>
  93 </tbody>
  94 </table></div>
  95 </div>
  96 <hr>
  97 <div class="refsect2">
  98 <a name="g-mime-part-iter-free"></a><h3>g_mime_part_iter_free ()</h3>
  99 <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>
 100 <p>
 101 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>.
 102 </p>
 103 <div class="variablelist"><table border="0">
 104 <col align="left" valign="top">
 105 <tbody><tr>
 106 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 107 <td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a>
 108 </td>
 109 </tr></tbody>
 110 </table></div>
 111 </div>
 112 <hr>
 113 <div class="refsect2">
 114 <a name="g-mime-part-iter-reset"></a><h3>g_mime_part_iter_reset ()</h3>
 115 <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>
 116 <p>
 117 Resets the state of <em class="parameter"><code>iter</code></em> to its initial state.
 118 </p>
 119 <div class="variablelist"><table border="0">
 120 <col align="left" valign="top">
 121 <tbody><tr>
 122 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 123 <td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a>
 124 </td>
 125 </tr></tbody>
 126 </table></div>
 127 </div>
 128 <hr>
 129 <div class="refsect2">
 130 <a name="g-mime-part-iter-jump-to"></a><h3>g_mime_part_iter_jump_to ()</h3>
 131 <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>,
 132                                                          <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre>
 133 <p>
 134 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
 135 by <em class="parameter"><code>path</code></em>.
 136 </p>
 137 <div class="variablelist"><table border="0">
 138 <col align="left" valign="top">
 139 <tbody>
 140 <tr>
 141 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 142 <td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a>
 143 </td>
 144 </tr>
 145 <tr>
 146 <td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
 147 <td>a string representing the path to jump to</td>
 148 </tr>
 149 <tr>
 150 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 151 <td>
 152 <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
 153 <code class="literal">FALSE</code> otherwise.</td>
 154 </tr>
 155 </tbody>
 156 </table></div>
 157 </div>
 158 <hr>
 159 <div class="refsect2">
 160 <a name="g-mime-part-iter-is-valid"></a><h3>g_mime_part_iter_is_valid ()</h3>
 161 <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>
 162 <p>
 163 Checks that the current state of <em class="parameter"><code>iter</code></em> is valid.
 164 </p>
 165 <div class="variablelist"><table border="0">
 166 <col align="left" valign="top">
 167 <tbody>
 168 <tr>
 169 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 170 <td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a>
 171 </td>
 172 </tr>
 173 <tr>
 174 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 175 <td>
 176 <code class="literal">TRUE</code> if <em class="parameter"><code>iter</code></em> is valid or <code class="literal">FALSE</code> otherwise.</td>
 177 </tr>
 178 </tbody>
 179 </table></div>
 180 </div>
 181 <hr>
 182 <div class="refsect2">
 183 <a name="g-mime-part-iter-next"></a><h3>g_mime_part_iter_next ()</h3>
 184 <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>
 185 <p>
 186 Advances to the next part in the MIME structure used to initialize
 187 <em class="parameter"><code>iter</code></em>.
 188 </p>
 189 <div class="variablelist"><table border="0">
 190 <col align="left" valign="top">
 191 <tbody>
 192 <tr>
 193 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 194 <td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a>
 195 </td>
 196 </tr>
 197 <tr>
 198 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 199 <td>
 200 <code class="literal">TRUE</code> if successful or <code class="literal">FALSE</code> otherwise.</td>
 201 </tr>
 202 </tbody>
 203 </table></div>
 204 </div>
 205 <hr>
 206 <div class="refsect2">
 207 <a name="g-mime-part-iter-prev"></a><h3>g_mime_part_iter_prev ()</h3>
 208 <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>
 209 <p>
 210 Rewinds to the previous part in the MIME structure used to
 211 initialize <em class="parameter"><code>iter</code></em>.
 212 </p>
 213 <div class="variablelist"><table border="0">
 214 <col align="left" valign="top">
 215 <tbody>
 216 <tr>
 217 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 218 <td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a>
 219 </td>
 220 </tr>
 221 <tr>
 222 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 223 <td>
 224 <code class="literal">TRUE</code> if successful or <code class="literal">FALSE</code> otherwise.</td>
 225 </tr>
 226 </tbody>
 227 </table></div>
 228 </div>
 229 <hr>
 230 <div class="refsect2">
 231 <a name="g-mime-part-iter-get-toplevel"></a><h3>g_mime_part_iter_get_toplevel ()</h3>
 232 <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>
 233 <p>
 234 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>.
 235 </p>
 236 <div class="variablelist"><table border="0">
 237 <col align="left" valign="top">
 238 <tbody>
 239 <tr>
 240 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 241 <td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a>
 242 </td>
 243 </tr>
 244 <tr>
 245 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 246 <td>the toplevel <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>.</td>
 247 </tr>
 248 </tbody>
 249 </table></div>
 250 </div>
 251 <hr>
 252 <div class="refsect2">
 253 <a name="g-mime-part-iter-get-current"></a><h3>g_mime_part_iter_get_current ()</h3>
 254 <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>
 255 <p>
 256 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.
 257 </p>
 258 <div class="variablelist"><table border="0">
 259 <col align="left" valign="top">
 260 <tbody>
 261 <tr>
 262 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 263 <td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a>
 264 </td>
 265 </tr>
 266 <tr>
 267 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 268 <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
 269 invalid.</td>
 270 </tr>
 271 </tbody>
 272 </table></div>
 273 </div>
 274 <hr>
 275 <div class="refsect2">
 276 <a name="g-mime-part-iter-get-parent"></a><h3>g_mime_part_iter_get_parent ()</h3>
 277 <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>
 278 <p>
 279 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>
 280 position.
 281 </p>
 282 <div class="variablelist"><table border="0">
 283 <col align="left" valign="top">
 284 <tbody>
 285 <tr>
 286 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 287 <td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a>
 288 </td>
 289 </tr>
 290 <tr>
 291 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 292 <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
 293 invalid.</td>
 294 </tr>
 295 </tbody>
 296 </table></div>
 297 </div>
 298 <hr>
 299 <div class="refsect2">
 300 <a name="g-mime-part-iter-get-path"></a><h3>g_mime_part_iter_get_path ()</h3>
 301 <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>
 302 <p>
 303 Gets the path of the current <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> in the MIME structure
 304 used to initialize <em class="parameter"><code>iter</code></em>.
 305 </p>
 306 <div class="variablelist"><table border="0">
 307 <col align="left" valign="top">
 308 <tbody>
 309 <tr>
 310 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 311 <td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a>
 312 </td>
 313 </tr>
 314 <tr>
 315 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 316 <td>a newly allocated string representation of the path to the
 317 <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>
 318 </tr>
 319 </tbody>
 320 </table></div>
 321 </div>
 322 <hr>
 323 <div class="refsect2">
 324 <a name="g-mime-part-iter-replace"></a><h3>g_mime_part_iter_replace ()</h3>
 325 <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>,
 326                                                          <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *replacement</code></em>);</pre>
 327 <p>
 328 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>.
 329 </p>
 330 <div class="variablelist"><table border="0">
 331 <col align="left" valign="top">
 332 <tbody>
 333 <tr>
 334 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 335 <td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a>
 336 </td>
 337 </tr>
 338 <tr>
 339 <td><p><span class="term"><em class="parameter"><code>replacement</code></em> :</span></p></td>
 340 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
 341 </td>
 342 </tr>
 343 <tr>
 344 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 345 <td>
 346 <code class="literal">TRUE</code> if the part at the current position was replaced or
 347 <code class="literal">FALSE</code> otherwise.</td>
 348 </tr>
 349 </tbody>
 350 </table></div>
 351 </div>
 352 <hr>
 353 <div class="refsect2">
 354 <a name="g-mime-part-iter-remove"></a><h3>g_mime_part_iter_remove ()</h3>
 355 <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>
 356 <p>
 357 Removes the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> at the current position from its
 358 parent. If successful, <em class="parameter"><code>iter</code></em> is advanced to the next position
 359 (since the current position will become invalid).
 360 </p>
 361 <div class="variablelist"><table border="0">
 362 <col align="left" valign="top">
 363 <tbody>
 364 <tr>
 365 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 366 <td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a>
 367 </td>
 368 </tr>
 369 <tr>
 370 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 371 <td>
 372 <code class="literal">TRUE</code> if the part at the current position was removed or
 373 <code class="literal">FALSE</code> otherwise.</td>
 374 </tr>
 375 </tbody>
 376 </table></div>
 377 </div>
 378 </div>
 379 <div class="refsect1">
 380 <a name="gmime-GMimePartIter.see-also"></a><h2>See Also</h2>
 381 <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
 382 </div>
 383 </div>
 384 <div class="footer">
 385 <hr>
 386           Generated by GTK-Doc V1.18</div>
 387 </body>
 388 </html>