docs/reference/html/GMimeFilter.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>GMimeFilter</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="Filters.html" title="Stream Filters">
   9 <link rel="prev" href="Filters.html" title="Stream Filters">
  10 <link rel="next" href="GMimeFilterBasic.html" title="GMimeFilterBasic">
  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="Filters.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="Filters.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="GMimeFilterBasic.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="#GMimeFilter.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GMimeFilter.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GMimeFilter.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GMimeFilter"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GMimeFilter.top_of_page"></a>GMimeFilter</span></h2>
  36 <p>GMimeFilter — Abstract filter class</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="GMimeFilter.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">struct              <a class="link" href="GMimeFilter.html#GMimeFilter-struct" title="struct GMimeFilter">GMimeFilter</a>;
  43 <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> *       <a class="link" href="GMimeFilter.html#g-mime-filter-copy" title="g_mime_filter_copy ()">g_mime_filter_copy</a>                  (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>);
  44 <span class="returnvalue">void</span>                <a class="link" href="GMimeFilter.html#g-mime-filter-filter" title="g_mime_filter_filter ()">g_mime_filter_filter</a>                (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>,
  45                                                          <em class="parameter"><code><span class="type">char</span> *inbuf</code></em>,
  46                                                          <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>,
  47                                                          <em class="parameter"><code><span class="type">size_t</span> prespace</code></em>,
  48                                                          <em class="parameter"><code><span class="type">char</span> **outbuf</code></em>,
  49                                                          <em class="parameter"><code><span class="type">size_t</span> *outlen</code></em>,
  50                                                          <em class="parameter"><code><span class="type">size_t</span> *outprespace</code></em>);
  51 <span class="returnvalue">void</span>                <a class="link" href="GMimeFilter.html#g-mime-filter-complete" title="g_mime_filter_complete ()">g_mime_filter_complete</a>              (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>,
  52                                                          <em class="parameter"><code><span class="type">char</span> *inbuf</code></em>,
  53                                                          <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>,
  54                                                          <em class="parameter"><code><span class="type">size_t</span> prespace</code></em>,
  55                                                          <em class="parameter"><code><span class="type">char</span> **outbuf</code></em>,
  56                                                          <em class="parameter"><code><span class="type">size_t</span> *outlen</code></em>,
  57                                                          <em class="parameter"><code><span class="type">size_t</span> *outprespace</code></em>);
  58 <span class="returnvalue">void</span>                <a class="link" href="GMimeFilter.html#g-mime-filter-reset" title="g_mime_filter_reset ()">g_mime_filter_reset</a>                 (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>);
  59 <span class="returnvalue">void</span>                <a class="link" href="GMimeFilter.html#g-mime-filter-backup" title="g_mime_filter_backup ()">g_mime_filter_backup</a>                (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>,
  60                                                          <em class="parameter"><code>const <span class="type">char</span> *data</code></em>,
  61                                                          <em class="parameter"><code><span class="type">size_t</span> length</code></em>);
  62 <span class="returnvalue">void</span>                <a class="link" href="GMimeFilter.html#g-mime-filter-set-size" title="g_mime_filter_set_size ()">g_mime_filter_set_size</a>              (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>,
  63                                                          <em class="parameter"><code><span class="type">size_t</span> size</code></em>,
  64                                                          <em class="parameter"><code><span class="type">gboolean</span> keep</code></em>);
  65 </pre>
  66 </div>
  67 <div class="refsect1">
  68 <a name="GMimeFilter.object-hierarchy"></a><h2>Object Hierarchy</h2>
  69 <pre class="synopsis">
  70   GObject
  71    +----GMimeFilter
  72          +----<a class="link" href="GMimeFilterBasic.html" title="GMimeFilterBasic">GMimeFilterBasic</a>
  73          +----<a class="link" href="GMimeFilterBest.html" title="GMimeFilterBest">GMimeFilterBest</a>
  74          +----<a class="link" href="GMimeFilterCharset.html" title="GMimeFilterCharset">GMimeFilterCharset</a>
  75          +----<a class="link" href="GMimeFilterCRLF.html" title="GMimeFilterCRLF">GMimeFilterCRLF</a>
  76          +----<a class="link" href="GMimeFilterEnriched.html" title="GMimeFilterEnriched">GMimeFilterEnriched</a>
  77          +----<a class="link" href="GMimeFilterFrom.html" title="GMimeFilterFrom">GMimeFilterFrom</a>
  78          +----<a class="link" href="GMimeFilterGZip.html" title="GMimeFilterGZip">GMimeFilterGZip</a>
  79          +----<a class="link" href="GMimeFilterHTML.html" title="GMimeFilterHTML">GMimeFilterHTML</a>
  80          +----<a class="link" href="GMimeFilterMd5.html" title="GMimeFilterMd5">GMimeFilterMd5</a>
  81          +----<a class="link" href="GMimeFilterStrip.html" title="GMimeFilterStrip">GMimeFilterStrip</a>
  82          +----<a class="link" href="GMimeFilterWindows.html" title="GMimeFilterWindows">GMimeFilterWindows</a>
  83          +----<a class="link" href="GMimeFilterYenc.html" title="GMimeFilterYenc">GMimeFilterYenc</a>
  84 </pre>
  85 </div>
  86 <div class="refsect1">
  87 <a name="GMimeFilter.description"></a><h2>Description</h2>
  88 <p>
  89 Stream filters are an efficient way of converting data from one
  90 format to another.
  91 </p>
  92 </div>
  93 <div class="refsect1">
  94 <a name="GMimeFilter.details"></a><h2>Details</h2>
  95 <div class="refsect2">
  96 <a name="GMimeFilter-struct"></a><h3>struct GMimeFilter</h3>
  97 <pre class="programlisting">struct GMimeFilter;</pre>
  98 <p>
  99 Base class for filters used by <a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a>.
 100 </p>
 101 <div class="variablelist"><table border="0">
 102 <col align="left" valign="top">
 103 <tbody></tbody>
 104 </table></div>
 105 </div>
 106 <hr>
 107 <div class="refsect2">
 108 <a name="g-mime-filter-copy"></a><h3>g_mime_filter_copy ()</h3>
 109 <pre class="programlisting"><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> *       g_mime_filter_copy                  (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>);</pre>
 110 <p>
 111 Copies <em class="parameter"><code>filter</code></em> into a new GMimeFilter object.
 112 </p>
 113 <div class="variablelist"><table border="0">
 114 <col align="left" valign="top">
 115 <tbody>
 116 <tr>
 117 <td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
 118 <td>filter</td>
 119 </tr>
 120 <tr>
 121 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 122 <td>a duplicate of <em class="parameter"><code>filter</code></em>.</td>
 123 </tr>
 124 </tbody>
 125 </table></div>
 126 </div>
 127 <hr>
 128 <div class="refsect2">
 129 <a name="g-mime-filter-filter"></a><h3>g_mime_filter_filter ()</h3>
 130 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_filter_filter                (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>,
 131                                                          <em class="parameter"><code><span class="type">char</span> *inbuf</code></em>,
 132                                                          <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>,
 133                                                          <em class="parameter"><code><span class="type">size_t</span> prespace</code></em>,
 134                                                          <em class="parameter"><code><span class="type">char</span> **outbuf</code></em>,
 135                                                          <em class="parameter"><code><span class="type">size_t</span> *outlen</code></em>,
 136                                                          <em class="parameter"><code><span class="type">size_t</span> *outprespace</code></em>);</pre>
 137 <p>
 138 Filters the input data and writes it to <em class="parameter"><code>out</code></em>.
 139 </p>
 140 <div class="variablelist"><table border="0">
 141 <col align="left" valign="top">
 142 <tbody>
 143 <tr>
 144 <td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
 145 <td>filter</td>
 146 </tr>
 147 <tr>
 148 <td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td>
 149 <td>input buffer</td>
 150 </tr>
 151 <tr>
 152 <td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td>
 153 <td>input buffer length</td>
 154 </tr>
 155 <tr>
 156 <td><p><span class="term"><em class="parameter"><code>prespace</code></em> :</span></p></td>
 157 <td>prespace buffer length</td>
 158 </tr>
 159 <tr>
 160 <td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td>
 161 <td>pointer to output buffer</td>
 162 </tr>
 163 <tr>
 164 <td><p><span class="term"><em class="parameter"><code>outlen</code></em> :</span></p></td>
 165 <td>pointer to output length</td>
 166 </tr>
 167 <tr>
 168 <td><p><span class="term"><em class="parameter"><code>outprespace</code></em> :</span></p></td>
 169 <td>pointer to output prespace buffer length</td>
 170 </tr>
 171 </tbody>
 172 </table></div>
 173 </div>
 174 <hr>
 175 <div class="refsect2">
 176 <a name="g-mime-filter-complete"></a><h3>g_mime_filter_complete ()</h3>
 177 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_filter_complete              (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>,
 178                                                          <em class="parameter"><code><span class="type">char</span> *inbuf</code></em>,
 179                                                          <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>,
 180                                                          <em class="parameter"><code><span class="type">size_t</span> prespace</code></em>,
 181                                                          <em class="parameter"><code><span class="type">char</span> **outbuf</code></em>,
 182                                                          <em class="parameter"><code><span class="type">size_t</span> *outlen</code></em>,
 183                                                          <em class="parameter"><code><span class="type">size_t</span> *outprespace</code></em>);</pre>
 184 <p>
 185 Completes the filtering.
 186 </p>
 187 <div class="variablelist"><table border="0">
 188 <col align="left" valign="top">
 189 <tbody>
 190 <tr>
 191 <td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
 192 <td>filter</td>
 193 </tr>
 194 <tr>
 195 <td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td>
 196 <td>input buffer</td>
 197 </tr>
 198 <tr>
 199 <td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td>
 200 <td>input buffer length</td>
 201 </tr>
 202 <tr>
 203 <td><p><span class="term"><em class="parameter"><code>prespace</code></em> :</span></p></td>
 204 <td>prespace buffer length</td>
 205 </tr>
 206 <tr>
 207 <td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td>
 208 <td>pointer to output buffer</td>
 209 </tr>
 210 <tr>
 211 <td><p><span class="term"><em class="parameter"><code>outlen</code></em> :</span></p></td>
 212 <td>pointer to output length</td>
 213 </tr>
 214 <tr>
 215 <td><p><span class="term"><em class="parameter"><code>outprespace</code></em> :</span></p></td>
 216 <td>pointer to output prespace buffer length</td>
 217 </tr>
 218 </tbody>
 219 </table></div>
 220 </div>
 221 <hr>
 222 <div class="refsect2">
 223 <a name="g-mime-filter-reset"></a><h3>g_mime_filter_reset ()</h3>
 224 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_filter_reset                 (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>);</pre>
 225 <p>
 226 Resets the filter.
 227 </p>
 228 <div class="variablelist"><table border="0">
 229 <col align="left" valign="top">
 230 <tbody><tr>
 231 <td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
 232 <td>a <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> object</td>
 233 </tr></tbody>
 234 </table></div>
 235 </div>
 236 <hr>
 237 <div class="refsect2">
 238 <a name="g-mime-filter-backup"></a><h3>g_mime_filter_backup ()</h3>
 239 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_filter_backup                (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>,
 240                                                          <em class="parameter"><code>const <span class="type">char</span> *data</code></em>,
 241                                                          <em class="parameter"><code><span class="type">size_t</span> length</code></em>);</pre>
 242 <p>
 243 Sets number of bytes backed up on the input, new calls replace
 244 previous ones
 245 </p>
 246 <div class="variablelist"><table border="0">
 247 <col align="left" valign="top">
 248 <tbody>
 249 <tr>
 250 <td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
 251 <td>filter</td>
 252 </tr>
 253 <tr>
 254 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 255 <td>data to backup</td>
 256 </tr>
 257 <tr>
 258 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
 259 <td>length of <em class="parameter"><code>data</code></em>
 260 </td>
 261 </tr>
 262 </tbody>
 263 </table></div>
 264 </div>
 265 <hr>
 266 <div class="refsect2">
 267 <a name="g-mime-filter-set-size"></a><h3>g_mime_filter_set_size ()</h3>
 268 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_filter_set_size              (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>,
 269                                                          <em class="parameter"><code><span class="type">size_t</span> size</code></em>,
 270                                                          <em class="parameter"><code><span class="type">gboolean</span> keep</code></em>);</pre>
 271 <p>
 272 Ensure this much size is available for filter output (if required)
 273 </p>
 274 <div class="variablelist"><table border="0">
 275 <col align="left" valign="top">
 276 <tbody>
 277 <tr>
 278 <td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
 279 <td>filter</td>
 280 </tr>
 281 <tr>
 282 <td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
 283 <td>requested size for the output buffer</td>
 284 </tr>
 285 <tr>
 286 <td><p><span class="term"><em class="parameter"><code>keep</code></em> :</span></p></td>
 287 <td>
 288 <code class="literal">TRUE</code> if existing data in the output buffer should be kept</td>
 289 </tr>
 290 </tbody>
 291 </table></div>
 292 </div>
 293 </div>
 294 <div class="refsect1">
 295 <a name="GMimeFilter.see-also"></a><h2>See Also</h2>
 296 <a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a>
 297 </div>
 298 </div>
 299 <div class="footer">
 300 <hr>
 301           Generated by GTK-Doc V1.18</div>
 302 </body>
 303 </html>