docs/reference/html/GMimeFilterYenc.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>GMimeFilterYenc</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="GMimeFilterWindows.html" title="GMimeFilterWindows">
  10 <link rel="next" href="DataWrappers.html" title="Data Wrappers">
  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="GMimeFilterWindows.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="DataWrappers.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="#GMimeFilterYenc.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GMimeFilterYenc.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GMimeFilterYenc.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GMimeFilterYenc"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GMimeFilterYenc.top_of_page"></a>GMimeFilterYenc</span></h2>
  36 <p>GMimeFilterYenc — yEncode or yDecode</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="GMimeFilterYenc.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">struct              <a class="link" href="GMimeFilterYenc.html#GMimeFilterYenc-struct" title="struct GMimeFilterYenc">GMimeFilterYenc</a>;
  43 <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> *       <a class="link" href="GMimeFilterYenc.html#g-mime-filter-yenc-new" title="g_mime_filter_yenc_new ()">g_mime_filter_yenc_new</a>              (<em class="parameter"><code><span class="type">gboolean</span> encode</code></em>);
  44 <span class="returnvalue">void</span>                <a class="link" href="GMimeFilterYenc.html#g-mime-filter-yenc-set-state" title="g_mime_filter_yenc_set_state ()">g_mime_filter_yenc_set_state</a>        (<em class="parameter"><code><a class="link" href="GMimeFilterYenc.html" title="GMimeFilterYenc"><span class="type">GMimeFilterYenc</span></a> *yenc</code></em>,
  45                                                          <em class="parameter"><code><span class="type">int</span> state</code></em>);
  46 <span class="returnvalue">void</span>                <a class="link" href="GMimeFilterYenc.html#g-mime-filter-yenc-set-crc" title="g_mime_filter_yenc_set_crc ()">g_mime_filter_yenc_set_crc</a>          (<em class="parameter"><code><a class="link" href="GMimeFilterYenc.html" title="GMimeFilterYenc"><span class="type">GMimeFilterYenc</span></a> *yenc</code></em>,
  47                                                          <em class="parameter"><code><span class="type">guint32</span> crc</code></em>);
  48 <span class="returnvalue">guint32</span>             <a class="link" href="GMimeFilterYenc.html#g-mime-filter-yenc-get-crc" title="g_mime_filter_yenc_get_crc ()">g_mime_filter_yenc_get_crc</a>          (<em class="parameter"><code><a class="link" href="GMimeFilterYenc.html" title="GMimeFilterYenc"><span class="type">GMimeFilterYenc</span></a> *yenc</code></em>);
  49 <span class="returnvalue">guint32</span>             <a class="link" href="GMimeFilterYenc.html#g-mime-filter-yenc-get-pcrc" title="g_mime_filter_yenc_get_pcrc ()">g_mime_filter_yenc_get_pcrc</a>         (<em class="parameter"><code><a class="link" href="GMimeFilterYenc.html" title="GMimeFilterYenc"><span class="type">GMimeFilterYenc</span></a> *yenc</code></em>);
  50
  51 #define             <a class="link" href="GMimeFilterYenc.html#GMIME-YENCODE-CRC-INIT:CAPS" title="GMIME_YENCODE_CRC_INIT">GMIME_YENCODE_CRC_INIT</a>
  52 #define             <a class="link" href="GMimeFilterYenc.html#GMIME-YENCODE-CRC-FINAL:CAPS" title="GMIME_YENCODE_CRC_FINAL()">GMIME_YENCODE_CRC_FINAL</a>             (crc)
  53 #define             <a class="link" href="GMimeFilterYenc.html#GMIME-YENCODE-STATE-INIT:CAPS" title="GMIME_YENCODE_STATE_INIT">GMIME_YENCODE_STATE_INIT</a>
  54 #define             <a class="link" href="GMimeFilterYenc.html#GMIME-YDECODE-STATE-INIT:CAPS" title="GMIME_YDECODE_STATE_INIT">GMIME_YDECODE_STATE_INIT</a>
  55 #define             <a class="link" href="GMimeFilterYenc.html#GMIME-YDECODE-STATE-EOLN:CAPS" title="GMIME_YDECODE_STATE_EOLN">GMIME_YDECODE_STATE_EOLN</a>
  56 #define             <a class="link" href="GMimeFilterYenc.html#GMIME-YDECODE-STATE-ESCAPE:CAPS" title="GMIME_YDECODE_STATE_ESCAPE">GMIME_YDECODE_STATE_ESCAPE</a>
  57 #define             <a class="link" href="GMimeFilterYenc.html#GMIME-YDECODE-STATE-END:CAPS" title="GMIME_YDECODE_STATE_END">GMIME_YDECODE_STATE_END</a>
  58 #define             <a class="link" href="GMimeFilterYenc.html#GMIME-YDECODE-STATE-BEGIN:CAPS" title="GMIME_YDECODE_STATE_BEGIN">GMIME_YDECODE_STATE_BEGIN</a>
  59 #define             <a class="link" href="GMimeFilterYenc.html#GMIME-YDECODE-STATE-DECODE:CAPS" title="GMIME_YDECODE_STATE_DECODE">GMIME_YDECODE_STATE_DECODE</a>
  60 #define             <a class="link" href="GMimeFilterYenc.html#GMIME-YDECODE-STATE-PART:CAPS" title="GMIME_YDECODE_STATE_PART">GMIME_YDECODE_STATE_PART</a>
  61 <span class="returnvalue">size_t</span>              <a class="link" href="GMimeFilterYenc.html#g-mime-ydecode-step" title="g_mime_ydecode_step ()">g_mime_ydecode_step</a>                 (<em class="parameter"><code>const unsigned <span class="type">char</span> *inbuf</code></em>,
  62                                                          <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>,
  63                                                          <em class="parameter"><code>unsigned <span class="type">char</span> *outbuf</code></em>,
  64                                                          <em class="parameter"><code><span class="type">int</span> *state</code></em>,
  65                                                          <em class="parameter"><code><span class="type">guint32</span> *pcrc</code></em>,
  66                                                          <em class="parameter"><code><span class="type">guint32</span> *crc</code></em>);
  67 <span class="returnvalue">size_t</span>              <a class="link" href="GMimeFilterYenc.html#g-mime-yencode-step" title="g_mime_yencode_step ()">g_mime_yencode_step</a>                 (<em class="parameter"><code>const unsigned <span class="type">char</span> *inbuf</code></em>,
  68                                                          <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>,
  69                                                          <em class="parameter"><code>unsigned <span class="type">char</span> *outbuf</code></em>,
  70                                                          <em class="parameter"><code><span class="type">int</span> *state</code></em>,
  71                                                          <em class="parameter"><code><span class="type">guint32</span> *pcrc</code></em>,
  72                                                          <em class="parameter"><code><span class="type">guint32</span> *crc</code></em>);
  73 <span class="returnvalue">size_t</span>              <a class="link" href="GMimeFilterYenc.html#g-mime-yencode-close" title="g_mime_yencode_close ()">g_mime_yencode_close</a>                (<em class="parameter"><code>const unsigned <span class="type">char</span> *inbuf</code></em>,
  74                                                          <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>,
  75                                                          <em class="parameter"><code>unsigned <span class="type">char</span> *outbuf</code></em>,
  76                                                          <em class="parameter"><code><span class="type">int</span> *state</code></em>,
  77                                                          <em class="parameter"><code><span class="type">guint32</span> *pcrc</code></em>,
  78                                                          <em class="parameter"><code><span class="type">guint32</span> *crc</code></em>);
  79 </pre>
  80 </div>
  81 <div class="refsect1">
  82 <a name="GMimeFilterYenc.object-hierarchy"></a><h2>Object Hierarchy</h2>
  83 <pre class="synopsis">
  84   GObject
  85    +----<a class="link" href="GMimeFilter.html" title="GMimeFilter">GMimeFilter</a>
  86          +----GMimeFilterYenc
  87 </pre>
  88 </div>
  89 <div class="refsect1">
  90 <a name="GMimeFilterYenc.description"></a><h2>Description</h2>
  91 <p>
  92 A <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> used to encode or decode the Usenet yEncoding.
  93 </p>
  94 </div>
  95 <div class="refsect1">
  96 <a name="GMimeFilterYenc.details"></a><h2>Details</h2>
  97 <div class="refsect2">
  98 <a name="GMimeFilterYenc-struct"></a><h3>struct GMimeFilterYenc</h3>
  99 <pre class="programlisting">struct GMimeFilterYenc;</pre>
 100 <p>
 101 A filter for yEncoding or yDecoding a stream.
 102 </p>
 103 <div class="variablelist"><table border="0">
 104 <col align="left" valign="top">
 105 <tbody></tbody>
 106 </table></div>
 107 </div>
 108 <hr>
 109 <div class="refsect2">
 110 <a name="g-mime-filter-yenc-new"></a><h3>g_mime_filter_yenc_new ()</h3>
 111 <pre class="programlisting"><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> *       g_mime_filter_yenc_new              (<em class="parameter"><code><span class="type">gboolean</span> encode</code></em>);</pre>
 112 <p>
 113 Creates a new yEnc filter.
 114 </p>
 115 <div class="variablelist"><table border="0">
 116 <col align="left" valign="top">
 117 <tbody>
 118 <tr>
 119 <td><p><span class="term"><em class="parameter"><code>encode</code></em> :</span></p></td>
 120 <td>encode vs decode</td>
 121 </tr>
 122 <tr>
 123 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 124 <td>a new yEnc filter.</td>
 125 </tr>
 126 </tbody>
 127 </table></div>
 128 </div>
 129 <hr>
 130 <div class="refsect2">
 131 <a name="g-mime-filter-yenc-set-state"></a><h3>g_mime_filter_yenc_set_state ()</h3>
 132 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_filter_yenc_set_state        (<em class="parameter"><code><a class="link" href="GMimeFilterYenc.html" title="GMimeFilterYenc"><span class="type">GMimeFilterYenc</span></a> *yenc</code></em>,
 133                                                          <em class="parameter"><code><span class="type">int</span> state</code></em>);</pre>
 134 <p>
 135 Sets the current state of the yencoder/ydecoder
 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>yenc</code></em> :</span></p></td>
 142 <td>yEnc filter</td>
 143 </tr>
 144 <tr>
 145 <td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
 146 <td>encode/decode state</td>
 147 </tr>
 148 </tbody>
 149 </table></div>
 150 </div>
 151 <hr>
 152 <div class="refsect2">
 153 <a name="g-mime-filter-yenc-set-crc"></a><h3>g_mime_filter_yenc_set_crc ()</h3>
 154 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_filter_yenc_set_crc          (<em class="parameter"><code><a class="link" href="GMimeFilterYenc.html" title="GMimeFilterYenc"><span class="type">GMimeFilterYenc</span></a> *yenc</code></em>,
 155                                                          <em class="parameter"><code><span class="type">guint32</span> crc</code></em>);</pre>
 156 <p>
 157 Sets the current crc32 value on the yEnc filter <em class="parameter"><code>yenc</code></em> to <em class="parameter"><code>crc</code></em>.
 158 </p>
 159 <div class="variablelist"><table border="0">
 160 <col align="left" valign="top">
 161 <tbody>
 162 <tr>
 163 <td><p><span class="term"><em class="parameter"><code>yenc</code></em> :</span></p></td>
 164 <td>yEnc filter</td>
 165 </tr>
 166 <tr>
 167 <td><p><span class="term"><em class="parameter"><code>crc</code></em> :</span></p></td>
 168 <td>crc32</td>
 169 </tr>
 170 </tbody>
 171 </table></div>
 172 </div>
 173 <hr>
 174 <div class="refsect2">
 175 <a name="g-mime-filter-yenc-get-crc"></a><h3>g_mime_filter_yenc_get_crc ()</h3>
 176 <pre class="programlisting"><span class="returnvalue">guint32</span>             g_mime_filter_yenc_get_crc          (<em class="parameter"><code><a class="link" href="GMimeFilterYenc.html" title="GMimeFilterYenc"><span class="type">GMimeFilterYenc</span></a> *yenc</code></em>);</pre>
 177 <p>
 178 Get the computed crc or (guint32) -1 on fail.
 179 </p>
 180 <div class="variablelist"><table border="0">
 181 <col align="left" valign="top">
 182 <tbody>
 183 <tr>
 184 <td><p><span class="term"><em class="parameter"><code>yenc</code></em> :</span></p></td>
 185 <td>yEnc filter</td>
 186 </tr>
 187 <tr>
 188 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 189 <td>the computed crc or (guint32) -1 on fail.</td>
 190 </tr>
 191 </tbody>
 192 </table></div>
 193 </div>
 194 <hr>
 195 <div class="refsect2">
 196 <a name="g-mime-filter-yenc-get-pcrc"></a><h3>g_mime_filter_yenc_get_pcrc ()</h3>
 197 <pre class="programlisting"><span class="returnvalue">guint32</span>             g_mime_filter_yenc_get_pcrc         (<em class="parameter"><code><a class="link" href="GMimeFilterYenc.html" title="GMimeFilterYenc"><span class="type">GMimeFilterYenc</span></a> *yenc</code></em>);</pre>
 198 <p>
 199 Get the computed part crc or (guint32) -1 on fail.
 200 </p>
 201 <div class="variablelist"><table border="0">
 202 <col align="left" valign="top">
 203 <tbody>
 204 <tr>
 205 <td><p><span class="term"><em class="parameter"><code>yenc</code></em> :</span></p></td>
 206 <td>yEnc filter</td>
 207 </tr>
 208 <tr>
 209 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 210 <td>the computed part crc or (guint32) -1 on fail.</td>
 211 </tr>
 212 </tbody>
 213 </table></div>
 214 </div>
 215 <hr>
 216 <div class="refsect2">
 217 <a name="GMIME-YENCODE-CRC-INIT:CAPS"></a><h3>GMIME_YENCODE_CRC_INIT</h3>
 218 <pre class="programlisting">#define GMIME_YENCODE_CRC_INIT       (~0)
 219 </pre>
 220 <p>
 221 Initial state for the crc and pcrc state variables.
 222 </p>
 223 </div>
 224 <hr>
 225 <div class="refsect2">
 226 <a name="GMIME-YENCODE-CRC-FINAL:CAPS"></a><h3>GMIME_YENCODE_CRC_FINAL()</h3>
 227 <pre class="programlisting">#define GMIME_YENCODE_CRC_FINAL(crc) (~crc)
 228 </pre>
 229 <p>
 230 Gets the final crc value from <em class="parameter"><code>crc</code></em>.
 231 </p>
 232 <div class="variablelist"><table border="0">
 233 <col align="left" valign="top">
 234 <tbody><tr>
 235 <td><p><span class="term"><em class="parameter"><code>crc</code></em> :</span></p></td>
 236 <td>crc or pcrc state variable</td>
 237 </tr></tbody>
 238 </table></div>
 239 </div>
 240 <hr>
 241 <div class="refsect2">
 242 <a name="GMIME-YENCODE-STATE-INIT:CAPS"></a><h3>GMIME_YENCODE_STATE_INIT</h3>
 243 <pre class="programlisting">#define GMIME_YENCODE_STATE_INIT     (0)
 244 </pre>
 245 <p>
 246 Initial state for the <a class="link" href="GMimeFilterYenc.html#g-mime-ydecode-step" title="g_mime_ydecode_step ()"><code class="function">g_mime_ydecode_step()</code></a> function.
 247 </p>
 248 </div>
 249 <hr>
 250 <div class="refsect2">
 251 <a name="GMIME-YDECODE-STATE-INIT:CAPS"></a><h3>GMIME_YDECODE_STATE_INIT</h3>
 252 <pre class="programlisting">#define GMIME_YDECODE_STATE_INIT     (0)
 253 </pre>
 254 <p>
 255 Initial state for the <a class="link" href="GMimeFilterYenc.html#g-mime-ydecode-step" title="g_mime_ydecode_step ()"><code class="function">g_mime_ydecode_step()</code></a> function.
 256 </p>
 257 </div>
 258 <hr>
 259 <div class="refsect2">
 260 <a name="GMIME-YDECODE-STATE-EOLN:CAPS"></a><h3>GMIME_YDECODE_STATE_EOLN</h3>
 261 <pre class="programlisting">#define GMIME_YDECODE_STATE_EOLN     (1 &lt;&lt; 8)
 262 </pre>
 263 <p>
 264 State bit that denotes the yEnc filter has reached an end-of-line.
 265 </p>
 266 <p>
 267 This state is for internal use only.
 268 </p>
 269 </div>
 270 <hr>
 271 <div class="refsect2">
 272 <a name="GMIME-YDECODE-STATE-ESCAPE:CAPS"></a><h3>GMIME_YDECODE_STATE_ESCAPE</h3>
 273 <pre class="programlisting">#define GMIME_YDECODE_STATE_ESCAPE   (1 &lt;&lt; 9)
 274 </pre>
 275 <p>
 276 State bit that denotes the yEnc filter has reached an escape
 277 sequence.
 278 </p>
 279 <p>
 280 This state is for internal use only.
 281 </p>
 282 </div>
 283 <hr>
 284 <div class="refsect2">
 285 <a name="GMIME-YDECODE-STATE-END:CAPS"></a><h3>GMIME_YDECODE_STATE_END</h3>
 286 <pre class="programlisting">#define GMIME_YDECODE_STATE_END      (1 &lt;&lt; 15)
 287 </pre>
 288 <p>
 289 State bit that denoates that <a class="link" href="GMimeFilterYenc.html#g-mime-ydecode-step" title="g_mime_ydecode_step ()"><code class="function">g_mime_ydecode_step()</code></a> has finished
 290 decoding.
 291 </p>
 292 </div>
 293 <hr>
 294 <div class="refsect2">
 295 <a name="GMIME-YDECODE-STATE-BEGIN:CAPS"></a><h3>GMIME_YDECODE_STATE_BEGIN</h3>
 296 <pre class="programlisting">#define GMIME_YDECODE_STATE_BEGIN    (1 &lt;&lt; 12)
 297 </pre>
 298 <p>
 299 State bit that denotes the yEnc filter has found the =ybegin line.
 300 </p>
 301 </div>
 302 <hr>
 303 <div class="refsect2">
 304 <a name="GMIME-YDECODE-STATE-DECODE:CAPS"></a><h3>GMIME_YDECODE_STATE_DECODE</h3>
 305 <pre class="programlisting">#define GMIME_YDECODE_STATE_DECODE   (1 &lt;&lt; 14)
 306 </pre>
 307 <p>
 308 State bit that denotes yEnc filter has begun decoding the actual
 309 yencoded content and will continue to do so until an =yend line is
 310 found (or until there is nothing left to decode).
 311 </p>
 312 </div>
 313 <hr>
 314 <div class="refsect2">
 315 <a name="GMIME-YDECODE-STATE-PART:CAPS"></a><h3>GMIME_YDECODE_STATE_PART</h3>
 316 <pre class="programlisting">#define GMIME_YDECODE_STATE_PART     (1 &lt;&lt; 13)
 317 </pre>
 318 <p>
 319 State bit that denotes the yEnc filter has found the =ypart
 320 line. (Note: not all yencoded blocks have one)
 321 </p>
 322 </div>
 323 <hr>
 324 <div class="refsect2">
 325 <a name="g-mime-ydecode-step"></a><h3>g_mime_ydecode_step ()</h3>
 326 <pre class="programlisting"><span class="returnvalue">size_t</span>              g_mime_ydecode_step                 (<em class="parameter"><code>const unsigned <span class="type">char</span> *inbuf</code></em>,
 327                                                          <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>,
 328                                                          <em class="parameter"><code>unsigned <span class="type">char</span> *outbuf</code></em>,
 329                                                          <em class="parameter"><code><span class="type">int</span> *state</code></em>,
 330                                                          <em class="parameter"><code><span class="type">guint32</span> *pcrc</code></em>,
 331                                                          <em class="parameter"><code><span class="type">guint32</span> *crc</code></em>);</pre>
 332 <p>
 333 Performs a 'decode step' on a chunk of yEncoded data of length
 334 <em class="parameter"><code>inlen</code></em> pointed to by <em class="parameter"><code>inbuf</code></em> and writes to <em class="parameter"><code>outbuf</code></em>. Assumes the =ybegin
 335 and =ypart lines have already been stripped off.
 336 </p>
 337 <p>
 338 To get the crc32 value of the part, use <a class="link" href="GMimeFilterYenc.html#GMIME-YENCODE-CRC-FINAL:CAPS" title="GMIME_YENCODE_CRC_FINAL()"><span class="type">GMIME_YENCODE_CRC_FINAL</span></a>
 339 (<em class="parameter"><code>pcrc</code></em>). If there are more parts, you should reuse <em class="parameter"><code>crc</code></em> without
 340 re-initializing. Once all parts have been decoded, you may get the
 341 combined crc32 value of all the parts using <a class="link" href="GMimeFilterYenc.html#GMIME-YENCODE-CRC-FINAL:CAPS" title="GMIME_YENCODE_CRC_FINAL()"><span class="type">GMIME_YENCODE_CRC_FINAL</span></a>
 342 (<em class="parameter"><code>crc</code></em>).
 343 </p>
 344 <div class="variablelist"><table border="0">
 345 <col align="left" valign="top">
 346 <tbody>
 347 <tr>
 348 <td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td>
 349 <td>input buffer</td>
 350 </tr>
 351 <tr>
 352 <td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td>
 353 <td>input buffer length</td>
 354 </tr>
 355 <tr>
 356 <td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td>
 357 <td>output buffer</td>
 358 </tr>
 359 <tr>
 360 <td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
 361 <td>ydecode state</td>
 362 </tr>
 363 <tr>
 364 <td><p><span class="term"><em class="parameter"><code>pcrc</code></em> :</span></p></td>
 365 <td>part crc state</td>
 366 </tr>
 367 <tr>
 368 <td><p><span class="term"><em class="parameter"><code>crc</code></em> :</span></p></td>
 369 <td>crc state</td>
 370 </tr>
 371 <tr>
 372 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 373 <td>the number of bytes decoded.</td>
 374 </tr>
 375 </tbody>
 376 </table></div>
 377 </div>
 378 <hr>
 379 <div class="refsect2">
 380 <a name="g-mime-yencode-step"></a><h3>g_mime_yencode_step ()</h3>
 381 <pre class="programlisting"><span class="returnvalue">size_t</span>              g_mime_yencode_step                 (<em class="parameter"><code>const unsigned <span class="type">char</span> *inbuf</code></em>,
 382                                                          <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>,
 383                                                          <em class="parameter"><code>unsigned <span class="type">char</span> *outbuf</code></em>,
 384                                                          <em class="parameter"><code><span class="type">int</span> *state</code></em>,
 385                                                          <em class="parameter"><code><span class="type">guint32</span> *pcrc</code></em>,
 386                                                          <em class="parameter"><code><span class="type">guint32</span> *crc</code></em>);</pre>
 387 <p>
 388 Performs an yEncode 'encode step' on a chunk of raw data of length
 389 <em class="parameter"><code>inlen</code></em> pointed to by <em class="parameter"><code>inbuf</code></em> and writes to <em class="parameter"><code>outbuf</code></em>.
 390 </p>
 391 <p>
 392 <em class="parameter"><code>state</code></em> should be initialized to <a class="link" href="GMimeFilterYenc.html#GMIME-YENCODE-STATE-INIT:CAPS" title="GMIME_YENCODE_STATE_INIT"><span class="type">GMIME_YENCODE_STATE_INIT</span></a> before
 393 beginning making the first call to this function. Subsequent calls
 394 should reuse <em class="parameter"><code>state</code></em>.
 395 </p>
 396 <p>
 397 Along the same lines, <em class="parameter"><code>pcrc</code></em> and <em class="parameter"><code>crc</code></em> should be initialized to
 398 <a class="link" href="GMimeFilterYenc.html#GMIME-YENCODE-CRC-INIT:CAPS" title="GMIME_YENCODE_CRC_INIT"><span class="type">GMIME_YENCODE_CRC_INIT</span></a> before using.
 399 </p>
 400 <div class="variablelist"><table border="0">
 401 <col align="left" valign="top">
 402 <tbody>
 403 <tr>
 404 <td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td>
 405 <td>input buffer</td>
 406 </tr>
 407 <tr>
 408 <td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td>
 409 <td>input buffer length</td>
 410 </tr>
 411 <tr>
 412 <td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td>
 413 <td>output buffer</td>
 414 </tr>
 415 <tr>
 416 <td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
 417 <td>yencode state</td>
 418 </tr>
 419 <tr>
 420 <td><p><span class="term"><em class="parameter"><code>pcrc</code></em> :</span></p></td>
 421 <td>part crc state</td>
 422 </tr>
 423 <tr>
 424 <td><p><span class="term"><em class="parameter"><code>crc</code></em> :</span></p></td>
 425 <td>crc state</td>
 426 </tr>
 427 <tr>
 428 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 429 <td>the number of bytes encoded.</td>
 430 </tr>
 431 </tbody>
 432 </table></div>
 433 </div>
 434 <hr>
 435 <div class="refsect2">
 436 <a name="g-mime-yencode-close"></a><h3>g_mime_yencode_close ()</h3>
 437 <pre class="programlisting"><span class="returnvalue">size_t</span>              g_mime_yencode_close                (<em class="parameter"><code>const unsigned <span class="type">char</span> *inbuf</code></em>,
 438                                                          <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>,
 439                                                          <em class="parameter"><code>unsigned <span class="type">char</span> *outbuf</code></em>,
 440                                                          <em class="parameter"><code><span class="type">int</span> *state</code></em>,
 441                                                          <em class="parameter"><code><span class="type">guint32</span> *pcrc</code></em>,
 442                                                          <em class="parameter"><code><span class="type">guint32</span> *crc</code></em>);</pre>
 443 <p>
 444 Call this function when finished encoding data with
 445 <a class="link" href="GMimeFilterYenc.html#g-mime-yencode-step" title="g_mime_yencode_step ()"><code class="function">g_mime_yencode_step()</code></a> to flush off the remaining state.
 446 </p>
 447 <p>
 448 <a class="link" href="GMimeFilterYenc.html#GMIME-YENCODE-CRC-FINAL:CAPS" title="GMIME_YENCODE_CRC_FINAL()"><span class="type">GMIME_YENCODE_CRC_FINAL</span></a> (<em class="parameter"><code>pcrc</code></em>) will give you the crc32 of the
 449 encoded "part". If there are more "parts" to encode, you should
 450 re-use <em class="parameter"><code>crc</code></em> when encoding the next "parts" and then use
 451 <a class="link" href="GMimeFilterYenc.html#GMIME-YENCODE-CRC-FINAL:CAPS" title="GMIME_YENCODE_CRC_FINAL()"><span class="type">GMIME_YENCODE_CRC_FINAL</span></a> (<em class="parameter"><code>crc</code></em>) to get the combined crc32 value of
 452 all the parts.
 453 </p>
 454 <div class="variablelist"><table border="0">
 455 <col align="left" valign="top">
 456 <tbody>
 457 <tr>
 458 <td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td>
 459 <td>input buffer</td>
 460 </tr>
 461 <tr>
 462 <td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td>
 463 <td>input buffer length</td>
 464 </tr>
 465 <tr>
 466 <td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td>
 467 <td>output buffer</td>
 468 </tr>
 469 <tr>
 470 <td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
 471 <td>yencode state</td>
 472 </tr>
 473 <tr>
 474 <td><p><span class="term"><em class="parameter"><code>pcrc</code></em> :</span></p></td>
 475 <td>part crc state</td>
 476 </tr>
 477 <tr>
 478 <td><p><span class="term"><em class="parameter"><code>crc</code></em> :</span></p></td>
 479 <td>crc state</td>
 480 </tr>
 481 <tr>
 482 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 483 <td>the number of bytes encoded.</td>
 484 </tr>
 485 </tbody>
 486 </table></div>
 487 </div>
 488 </div>
 489 <div class="refsect1">
 490 <a name="GMimeFilterYenc.see-also"></a><h2>See Also</h2>
 491 <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a>
 492 </div>
 493 </div>
 494 <div class="footer">
 495 <hr>
 496           Generated by GTK-Doc V1.18</div>
 497 </body>
 498 </html>