/usr/share/gtk-doc/html/camel/CamelMimeFilterYenc.html is in libcamel1.2-dev 3.2.3-0ubuntu6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelMimeFilterYenc</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Stream-Filters.html" title="Stream Filters">
<link rel="prev" href="CamelMimeFilterWindows.html" title="CamelMimeFilterWindows">
<link rel="next" href="Services.html" title="Services">
<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="CamelMimeFilterWindows.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Stream-Filters.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">Camel Reference Manual</th>
<td><a accesskey="n" href="Services.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#CamelMimeFilterYenc.synopsis" class="shortcut">Top</a>
|
<a href="#CamelMimeFilterYenc.description" class="shortcut">Description</a>
|
<a href="#CamelMimeFilterYenc.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="CamelMimeFilterYenc"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CamelMimeFilterYenc.top_of_page"></a>CamelMimeFilterYenc</span></h2>
<p>CamelMimeFilterYenc</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="CamelMimeFilterYenc.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="CamelMimeFilterYenc.html#CamelMimeFilterYenc-struct" title="struct CamelMimeFilterYenc">CamelMimeFilterYenc</a>;
enum <a class="link" href="CamelMimeFilterYenc.html#CamelMimeFilterYencDirection" title="enum CamelMimeFilterYencDirection">CamelMimeFilterYencDirection</a>;
#define <a class="link" href="CamelMimeFilterYenc.html#CAMEL-MIME-YDECODE-STATE-INIT:CAPS" title="CAMEL_MIME_YDECODE_STATE_INIT">CAMEL_MIME_YDECODE_STATE_INIT</a>
#define <a class="link" href="CamelMimeFilterYenc.html#CAMEL-MIME-YENCODE-STATE-INIT:CAPS" title="CAMEL_MIME_YENCODE_STATE_INIT">CAMEL_MIME_YENCODE_STATE_INIT</a>
#define <a class="link" href="CamelMimeFilterYenc.html#CAMEL-MIME-YDECODE-STATE-EOLN:CAPS" title="CAMEL_MIME_YDECODE_STATE_EOLN">CAMEL_MIME_YDECODE_STATE_EOLN</a>
#define <a class="link" href="CamelMimeFilterYenc.html#CAMEL-MIME-YDECODE-STATE-ESCAPE:CAPS" title="CAMEL_MIME_YDECODE_STATE_ESCAPE">CAMEL_MIME_YDECODE_STATE_ESCAPE</a>
#define <a class="link" href="CamelMimeFilterYenc.html#CAMEL-MIME-YDECODE-STATE-BEGIN:CAPS" title="CAMEL_MIME_YDECODE_STATE_BEGIN">CAMEL_MIME_YDECODE_STATE_BEGIN</a>
#define <a class="link" href="CamelMimeFilterYenc.html#CAMEL-MIME-YDECODE-STATE-PART:CAPS" title="CAMEL_MIME_YDECODE_STATE_PART">CAMEL_MIME_YDECODE_STATE_PART</a>
#define <a class="link" href="CamelMimeFilterYenc.html#CAMEL-MIME-YDECODE-STATE-DECODE:CAPS" title="CAMEL_MIME_YDECODE_STATE_DECODE">CAMEL_MIME_YDECODE_STATE_DECODE</a>
#define <a class="link" href="CamelMimeFilterYenc.html#CAMEL-MIME-YDECODE-STATE-END:CAPS" title="CAMEL_MIME_YDECODE_STATE_END">CAMEL_MIME_YDECODE_STATE_END</a>
#define <a class="link" href="CamelMimeFilterYenc.html#CAMEL-MIME-YENCODE-CRC-INIT:CAPS" title="CAMEL_MIME_YENCODE_CRC_INIT">CAMEL_MIME_YENCODE_CRC_INIT</a>
#define <a class="link" href="CamelMimeFilterYenc.html#CAMEL-MIME-YENCODE-CRC-FINAL:CAPS" title="CAMEL_MIME_YENCODE_CRC_FINAL()">CAMEL_MIME_YENCODE_CRC_FINAL</a> (crc)
<a class="link" href="CamelMimeFilter.html" title="CamelMimeFilter"><span class="returnvalue">CamelMimeFilter</span></a> * <a class="link" href="CamelMimeFilterYenc.html#camel-mime-filter-yenc-new" title="camel_mime_filter_yenc_new ()">camel_mime_filter_yenc_new</a> (<em class="parameter"><code><a class="link" href="CamelMimeFilterYenc.html#CamelMimeFilterYencDirection" title="enum CamelMimeFilterYencDirection"><span class="type">CamelMimeFilterYencDirection</span></a> direction</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelMimeFilterYenc.html#camel-mime-filter-yenc-set-state" title="camel_mime_filter_yenc_set_state ()">camel_mime_filter_yenc_set_state</a> (<em class="parameter"><code><a class="link" href="CamelMimeFilterYenc.html" title="CamelMimeFilterYenc"><span class="type">CamelMimeFilterYenc</span></a> *yenc</code></em>,
<em class="parameter"><code><span class="type">gint</span> state</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelMimeFilterYenc.html#camel-mime-filter-yenc-set-crc" title="camel_mime_filter_yenc_set_crc ()">camel_mime_filter_yenc_set_crc</a> (<em class="parameter"><code><a class="link" href="CamelMimeFilterYenc.html" title="CamelMimeFilterYenc"><span class="type">CamelMimeFilterYenc</span></a> *yenc</code></em>,
<em class="parameter"><code><span class="type">guint32</span> crc</code></em>);
<span class="returnvalue">guint32</span> <a class="link" href="CamelMimeFilterYenc.html#camel-mime-filter-yenc-get-pcrc" title="camel_mime_filter_yenc_get_pcrc ()">camel_mime_filter_yenc_get_pcrc</a> (<em class="parameter"><code><a class="link" href="CamelMimeFilterYenc.html" title="CamelMimeFilterYenc"><span class="type">CamelMimeFilterYenc</span></a> *yenc</code></em>);
<span class="returnvalue">guint32</span> <a class="link" href="CamelMimeFilterYenc.html#camel-mime-filter-yenc-get-crc" title="camel_mime_filter_yenc_get_crc ()">camel_mime_filter_yenc_get_crc</a> (<em class="parameter"><code><a class="link" href="CamelMimeFilterYenc.html" title="CamelMimeFilterYenc"><span class="type">CamelMimeFilterYenc</span></a> *yenc</code></em>);
<span class="returnvalue">gsize</span> <a class="link" href="CamelMimeFilterYenc.html#camel-ydecode-step" title="camel_ydecode_step ()">camel_ydecode_step</a> (<em class="parameter"><code>const <span class="type">guchar</span> *in</code></em>,
<em class="parameter"><code><span class="type">gsize</span> inlen</code></em>,
<em class="parameter"><code><span class="type">guchar</span> *out</code></em>,
<em class="parameter"><code><span class="type">gint</span> *state</code></em>,
<em class="parameter"><code><span class="type">guint32</span> *pcrc</code></em>,
<em class="parameter"><code><span class="type">guint32</span> *crc</code></em>);
<span class="returnvalue">gsize</span> <a class="link" href="CamelMimeFilterYenc.html#camel-yencode-step" title="camel_yencode_step ()">camel_yencode_step</a> (<em class="parameter"><code>const <span class="type">guchar</span> *in</code></em>,
<em class="parameter"><code><span class="type">gsize</span> inlen</code></em>,
<em class="parameter"><code><span class="type">guchar</span> *out</code></em>,
<em class="parameter"><code><span class="type">gint</span> *state</code></em>,
<em class="parameter"><code><span class="type">guint32</span> *pcrc</code></em>,
<em class="parameter"><code><span class="type">guint32</span> *crc</code></em>);
<span class="returnvalue">gsize</span> <a class="link" href="CamelMimeFilterYenc.html#camel-yencode-close" title="camel_yencode_close ()">camel_yencode_close</a> (<em class="parameter"><code>const <span class="type">guchar</span> *in</code></em>,
<em class="parameter"><code><span class="type">gsize</span> inlen</code></em>,
<em class="parameter"><code><span class="type">guchar</span> *out</code></em>,
<em class="parameter"><code><span class="type">gint</span> *state</code></em>,
<em class="parameter"><code><span class="type">guint32</span> *pcrc</code></em>,
<em class="parameter"><code><span class="type">guint32</span> *crc</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="CamelMimeFilterYenc.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a class="link" href="CamelObject.html" title="CamelObject">CamelObject</a>
+----<a class="link" href="CamelMimeFilter.html" title="CamelMimeFilter">CamelMimeFilter</a>
+----CamelMimeFilterYenc
</pre>
</div>
<div class="refsect1">
<a name="CamelMimeFilterYenc.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="CamelMimeFilterYenc.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelMimeFilterYenc-struct"></a><h3>struct CamelMimeFilterYenc</h3>
<pre class="programlisting">struct CamelMimeFilterYenc;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelMimeFilterYencDirection"></a><h3>enum CamelMimeFilterYencDirection</h3>
<pre class="programlisting">typedef enum {
CAMEL_MIME_FILTER_YENC_DIRECTION_ENCODE,
CAMEL_MIME_FILTER_YENC_DIRECTION_DECODE
} CamelMimeFilterYencDirection;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-MIME-YDECODE-STATE-INIT:CAPS"></a><h3>CAMEL_MIME_YDECODE_STATE_INIT</h3>
<pre class="programlisting">#define CAMEL_MIME_YDECODE_STATE_INIT (0)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-MIME-YENCODE-STATE-INIT:CAPS"></a><h3>CAMEL_MIME_YENCODE_STATE_INIT</h3>
<pre class="programlisting">#define CAMEL_MIME_YENCODE_STATE_INIT (0)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-MIME-YDECODE-STATE-EOLN:CAPS"></a><h3>CAMEL_MIME_YDECODE_STATE_EOLN</h3>
<pre class="programlisting">#define CAMEL_MIME_YDECODE_STATE_EOLN (1 << 8)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-MIME-YDECODE-STATE-ESCAPE:CAPS"></a><h3>CAMEL_MIME_YDECODE_STATE_ESCAPE</h3>
<pre class="programlisting">#define CAMEL_MIME_YDECODE_STATE_ESCAPE (1 << 9)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-MIME-YDECODE-STATE-BEGIN:CAPS"></a><h3>CAMEL_MIME_YDECODE_STATE_BEGIN</h3>
<pre class="programlisting">#define CAMEL_MIME_YDECODE_STATE_BEGIN (1 << 12)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-MIME-YDECODE-STATE-PART:CAPS"></a><h3>CAMEL_MIME_YDECODE_STATE_PART</h3>
<pre class="programlisting">#define CAMEL_MIME_YDECODE_STATE_PART (1 << 13)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-MIME-YDECODE-STATE-DECODE:CAPS"></a><h3>CAMEL_MIME_YDECODE_STATE_DECODE</h3>
<pre class="programlisting">#define CAMEL_MIME_YDECODE_STATE_DECODE (1 << 14)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-MIME-YDECODE-STATE-END:CAPS"></a><h3>CAMEL_MIME_YDECODE_STATE_END</h3>
<pre class="programlisting">#define CAMEL_MIME_YDECODE_STATE_END (1 << 15)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-MIME-YENCODE-CRC-INIT:CAPS"></a><h3>CAMEL_MIME_YENCODE_CRC_INIT</h3>
<pre class="programlisting">#define CAMEL_MIME_YENCODE_CRC_INIT (~0)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-MIME-YENCODE-CRC-FINAL:CAPS"></a><h3>CAMEL_MIME_YENCODE_CRC_FINAL()</h3>
<pre class="programlisting">#define CAMEL_MIME_YENCODE_CRC_FINAL(crc) (~crc)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-filter-yenc-new"></a><h3>camel_mime_filter_yenc_new ()</h3>
<pre class="programlisting"><a class="link" href="CamelMimeFilter.html" title="CamelMimeFilter"><span class="returnvalue">CamelMimeFilter</span></a> * camel_mime_filter_yenc_new (<em class="parameter"><code><a class="link" href="CamelMimeFilterYenc.html#CamelMimeFilterYencDirection" title="enum CamelMimeFilterYencDirection"><span class="type">CamelMimeFilterYencDirection</span></a> direction</code></em>);</pre>
<p>
Create a new <a class="link" href="CamelMimeFilterYenc.html" title="CamelMimeFilterYenc"><span class="type">CamelMimeFilterYenc</span></a> filter object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
<td>encode direction</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="CamelMimeFilterYenc.html" title="CamelMimeFilterYenc"><span class="type">CamelMimeFilterYenc</span></a> object</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-filter-yenc-set-state"></a><h3>camel_mime_filter_yenc_set_state ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_mime_filter_yenc_set_state (<em class="parameter"><code><a class="link" href="CamelMimeFilterYenc.html" title="CamelMimeFilterYenc"><span class="type">CamelMimeFilterYenc</span></a> *yenc</code></em>,
<em class="parameter"><code><span class="type">gint</span> state</code></em>);</pre>
<p>
Sets the current state of the yencoder/ydecoder
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>yenc</code></em> :</span></p></td>
<td>a <a class="link" href="CamelMimeFilterYenc.html" title="CamelMimeFilterYenc"><span class="type">CamelMimeFilterYenc</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
<td>encode/decode state</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-filter-yenc-set-crc"></a><h3>camel_mime_filter_yenc_set_crc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_mime_filter_yenc_set_crc (<em class="parameter"><code><a class="link" href="CamelMimeFilterYenc.html" title="CamelMimeFilterYenc"><span class="type">CamelMimeFilterYenc</span></a> *yenc</code></em>,
<em class="parameter"><code><span class="type">guint32</span> crc</code></em>);</pre>
<p>
Sets the current crc32 value on the yEnc filter <em class="parameter"><code>yenc</code></em> to <em class="parameter"><code>crc</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>yenc</code></em> :</span></p></td>
<td>a <a class="link" href="CamelMimeFilterYenc.html" title="CamelMimeFilterYenc"><span class="type">CamelMimeFilterYenc</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>crc</code></em> :</span></p></td>
<td>crc32 value</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-filter-yenc-get-pcrc"></a><h3>camel_mime_filter_yenc_get_pcrc ()</h3>
<pre class="programlisting"><span class="returnvalue">guint32</span> camel_mime_filter_yenc_get_pcrc (<em class="parameter"><code><a class="link" href="CamelMimeFilterYenc.html" title="CamelMimeFilterYenc"><span class="type">CamelMimeFilterYenc</span></a> *yenc</code></em>);</pre>
<p>
Get the computed part crc or (<span class="type">guint32</span>) <code class="literal">-1</code> on fail.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>yenc</code></em> :</span></p></td>
<td>a <a class="link" href="CamelMimeFilterYenc.html" title="CamelMimeFilterYenc"><span class="type">CamelMimeFilterYenc</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the computed part crc or (<span class="type">guint32</span>) <code class="literal">-1</code> on fail.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-filter-yenc-get-crc"></a><h3>camel_mime_filter_yenc_get_crc ()</h3>
<pre class="programlisting"><span class="returnvalue">guint32</span> camel_mime_filter_yenc_get_crc (<em class="parameter"><code><a class="link" href="CamelMimeFilterYenc.html" title="CamelMimeFilterYenc"><span class="type">CamelMimeFilterYenc</span></a> *yenc</code></em>);</pre>
<p>
Get the computed crc or (<span class="type">guint32</span>) -1 on fail.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>yenc</code></em> :</span></p></td>
<td>a <span class="type">CamelMimeFiletrYenc</span> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the computed crc or (<span class="type">guint32</span>) -1 on fail.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-ydecode-step"></a><h3>camel_ydecode_step ()</h3>
<pre class="programlisting"><span class="returnvalue">gsize</span> camel_ydecode_step (<em class="parameter"><code>const <span class="type">guchar</span> *in</code></em>,
<em class="parameter"><code><span class="type">gsize</span> inlen</code></em>,
<em class="parameter"><code><span class="type">guchar</span> *out</code></em>,
<em class="parameter"><code><span class="type">gint</span> *state</code></em>,
<em class="parameter"><code><span class="type">guint32</span> *pcrc</code></em>,
<em class="parameter"><code><span class="type">guint32</span> *crc</code></em>);</pre>
<p>
Performs a 'decode step' on a chunk of yEncoded data of length
<em class="parameter"><code>inlen</code></em> pointed to by <em class="parameter"><code>in</code></em> and writes to <em class="parameter"><code>out</code></em>. Assumes the =ybegin
and =ypart lines have already been stripped off.
</p>
<p>
To get the crc32 value of the part, use <a class="link" href="CamelMimeFilterYenc.html#CAMEL-MIME-YENCODE-CRC-FINAL:CAPS" title="CAMEL_MIME_YENCODE_CRC_FINAL()"><span class="type">CAMEL_MIME_YENCODE_CRC_FINAL</span></a>
(<em class="parameter"><code>pcrc</code></em>). If there are more parts, you should reuse <em class="parameter"><code>crc</code></em> without
re-initializing. Once all parts have been decoded, you may get the
combined crc32 value of all the parts using <a class="link" href="CamelMimeFilterYenc.html#CAMEL-MIME-YENCODE-CRC-FINAL:CAPS" title="CAMEL_MIME_YENCODE_CRC_FINAL()"><span class="type">CAMEL_MIME_YENCODE_CRC_FINAL</span></a>
(<em class="parameter"><code>crc</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>in</code></em> :</span></p></td>
<td>input buffer</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td>
<td>input buffer length</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>out</code></em> :</span></p></td>
<td>output buffer</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
<td>ydecode state</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pcrc</code></em> :</span></p></td>
<td>part crc state</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>crc</code></em> :</span></p></td>
<td>crc state</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the number of bytes decoded</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-yencode-step"></a><h3>camel_yencode_step ()</h3>
<pre class="programlisting"><span class="returnvalue">gsize</span> camel_yencode_step (<em class="parameter"><code>const <span class="type">guchar</span> *in</code></em>,
<em class="parameter"><code><span class="type">gsize</span> inlen</code></em>,
<em class="parameter"><code><span class="type">guchar</span> *out</code></em>,
<em class="parameter"><code><span class="type">gint</span> *state</code></em>,
<em class="parameter"><code><span class="type">guint32</span> *pcrc</code></em>,
<em class="parameter"><code><span class="type">guint32</span> *crc</code></em>);</pre>
<p>
Performs an yEncode 'encode step' on a chunk of raw data of length
<em class="parameter"><code>inlen</code></em> pointed to by <em class="parameter"><code>in</code></em> and writes to <em class="parameter"><code>out</code></em>.
</p>
<p>
<em class="parameter"><code>state</code></em> should be initialized to <a class="link" href="CamelMimeFilterYenc.html#CAMEL-MIME-YENCODE-STATE-INIT:CAPS" title="CAMEL_MIME_YENCODE_STATE_INIT"><span class="type">CAMEL_MIME_YENCODE_STATE_INIT</span></a> before
beginning making the first call to this function. Subsequent calls
should reuse <em class="parameter"><code>state</code></em>.
</p>
<p>
Along the same lines, <em class="parameter"><code>pcrc</code></em> and <em class="parameter"><code>crc</code></em> should be initialized to
<a class="link" href="CamelMimeFilterYenc.html#CAMEL-MIME-YENCODE-CRC-INIT:CAPS" title="CAMEL_MIME_YENCODE_CRC_INIT"><span class="type">CAMEL_MIME_YENCODE_CRC_INIT</span></a> before using.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>in</code></em> :</span></p></td>
<td>input buffer</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td>
<td>input buffer length</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>out</code></em> :</span></p></td>
<td>output buffer</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
<td>yencode state</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pcrc</code></em> :</span></p></td>
<td>part crc state</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>crc</code></em> :</span></p></td>
<td>crc state</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the number of bytes encoded</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-yencode-close"></a><h3>camel_yencode_close ()</h3>
<pre class="programlisting"><span class="returnvalue">gsize</span> camel_yencode_close (<em class="parameter"><code>const <span class="type">guchar</span> *in</code></em>,
<em class="parameter"><code><span class="type">gsize</span> inlen</code></em>,
<em class="parameter"><code><span class="type">guchar</span> *out</code></em>,
<em class="parameter"><code><span class="type">gint</span> *state</code></em>,
<em class="parameter"><code><span class="type">guint32</span> *pcrc</code></em>,
<em class="parameter"><code><span class="type">guint32</span> *crc</code></em>);</pre>
<p>
Call this function when finished encoding data with
<a class="link" href="CamelMimeFilterYenc.html#camel-yencode-step" title="camel_yencode_step ()"><code class="function">camel_yencode_step()</code></a> to flush off the remaining state.
</p>
<p>
<a class="link" href="CamelMimeFilterYenc.html#CAMEL-MIME-YENCODE-CRC-FINAL:CAPS" title="CAMEL_MIME_YENCODE_CRC_FINAL()"><span class="type">CAMEL_MIME_YENCODE_CRC_FINAL</span></a> (<em class="parameter"><code>pcrc</code></em>) will give you the crc32 of the
encoded "part". If there are more "parts" to encode, you should
re-use <em class="parameter"><code>crc</code></em> when encoding the next "parts" and then use
<a class="link" href="CamelMimeFilterYenc.html#CAMEL-MIME-YENCODE-CRC-FINAL:CAPS" title="CAMEL_MIME_YENCODE_CRC_FINAL()"><span class="type">CAMEL_MIME_YENCODE_CRC_FINAL</span></a> (<em class="parameter"><code>crc</code></em>) to get the combined crc32 value of
all the parts.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>in</code></em> :</span></p></td>
<td>input buffer</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td>
<td>input buffer length</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>out</code></em> :</span></p></td>
<td>output buffer</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
<td>yencode state</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pcrc</code></em> :</span></p></td>
<td>part crc state</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>crc</code></em> :</span></p></td>
<td>crc state</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the number of bytes encoded.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|