1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
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">
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">
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>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#GMimeFilterYenc.synopsis" class="shortcut">Top</a>
26 <a href="#GMimeFilterYenc.description" class="shortcut">Description</a>
28 <a href="#GMimeFilterYenc.object-hierarchy" class="shortcut">Object Hierarchy</a>
31 <div class="refentry">
32 <a name="GMimeFilterYenc"></a><div class="titlepage"></div>
33 <div class="refnamediv"><table width="100%"><tr>
35 <h2><span class="refentrytitle"><a name="GMimeFilterYenc.top_of_page"></a>GMimeFilterYenc</span></h2>
36 <p>GMimeFilterYenc — yEncode or yDecode</p>
38 <td valign="top" align="right"></td>
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>);
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>);
81 <div class="refsect1">
82 <a name="GMimeFilterYenc.object-hierarchy"></a><h2>Object Hierarchy</h2>
83 <pre class="synopsis">
85 +----<a class="link" href="GMimeFilter.html" title="GMimeFilter">GMimeFilter</a>
89 <div class="refsect1">
90 <a name="GMimeFilterYenc.description"></a><h2>Description</h2>
92 A <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> used to encode or decode the Usenet yEncoding.
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>
101 A filter for yEncoding or yDecoding a stream.
103 <div class="variablelist"><table border="0">
104 <col align="left" valign="top">
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>
113 Creates a new yEnc filter.
115 <div class="variablelist"><table border="0">
116 <col align="left" valign="top">
119 <td><p><span class="term"><em class="parameter"><code>encode</code></em> :</span></p></td>
120 <td>encode vs decode</td>
123 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
124 <td>a new yEnc filter.</td>
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>
135 Sets the current state of the yencoder/ydecoder
137 <div class="variablelist"><table border="0">
138 <col align="left" valign="top">
141 <td><p><span class="term"><em class="parameter"><code>yenc</code></em> :</span></p></td>
145 <td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
146 <td>encode/decode state</td>
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>
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>.
159 <div class="variablelist"><table border="0">
160 <col align="left" valign="top">
163 <td><p><span class="term"><em class="parameter"><code>yenc</code></em> :</span></p></td>
167 <td><p><span class="term"><em class="parameter"><code>crc</code></em> :</span></p></td>
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>
178 Get the computed crc or (guint32) -1 on fail.
180 <div class="variablelist"><table border="0">
181 <col align="left" valign="top">
184 <td><p><span class="term"><em class="parameter"><code>yenc</code></em> :</span></p></td>
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>
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>
199 Get the computed part crc or (guint32) -1 on fail.
201 <div class="variablelist"><table border="0">
202 <col align="left" valign="top">
205 <td><p><span class="term"><em class="parameter"><code>yenc</code></em> :</span></p></td>
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>
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)
221 Initial state for the crc and pcrc state variables.
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)
230 Gets the final crc value from <em class="parameter"><code>crc</code></em>.
232 <div class="variablelist"><table border="0">
233 <col align="left" valign="top">
235 <td><p><span class="term"><em class="parameter"><code>crc</code></em> :</span></p></td>
236 <td>crc or pcrc state variable</td>
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)
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.
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)
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.
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 << 8)
264 State bit that denotes the yEnc filter has reached an end-of-line.
267 This state is for internal use only.
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 << 9)
276 State bit that denotes the yEnc filter has reached an escape
280 This state is for internal use only.
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 << 15)
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
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 << 12)
299 State bit that denotes the yEnc filter has found the =ybegin line.
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 << 14)
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).
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 << 13)
319 State bit that denotes the yEnc filter has found the =ypart
320 line. (Note: not all yencoded blocks have one)
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>
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.
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>).
344 <div class="variablelist"><table border="0">
345 <col align="left" valign="top">
348 <td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td>
349 <td>input buffer</td>
352 <td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td>
353 <td>input buffer length</td>
356 <td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td>
357 <td>output buffer</td>
360 <td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
361 <td>ydecode state</td>
364 <td><p><span class="term"><em class="parameter"><code>pcrc</code></em> :</span></p></td>
365 <td>part crc state</td>
368 <td><p><span class="term"><em class="parameter"><code>crc</code></em> :</span></p></td>
372 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
373 <td>the number of bytes decoded.</td>
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>
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>.
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>.
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.
400 <div class="variablelist"><table border="0">
401 <col align="left" valign="top">
404 <td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td>
405 <td>input buffer</td>
408 <td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td>
409 <td>input buffer length</td>
412 <td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td>
413 <td>output buffer</td>
416 <td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
417 <td>yencode state</td>
420 <td><p><span class="term"><em class="parameter"><code>pcrc</code></em> :</span></p></td>
421 <td>part crc state</td>
424 <td><p><span class="term"><em class="parameter"><code>crc</code></em> :</span></p></td>
428 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
429 <td>the number of bytes encoded.</td>
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>
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.
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
454 <div class="variablelist"><table border="0">
455 <col align="left" valign="top">
458 <td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td>
459 <td>input buffer</td>
462 <td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td>
463 <td>input buffer length</td>
466 <td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td>
467 <td>output buffer</td>
470 <td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
471 <td>yencode state</td>
474 <td><p><span class="term"><em class="parameter"><code>pcrc</code></em> :</span></p></td>
475 <td>part crc state</td>
478 <td><p><span class="term"><em class="parameter"><code>crc</code></em> :</span></p></td>
482 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
483 <td>the number of bytes encoded.</td>
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>
496 Generated by GTK-Doc V1.18</div>