← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to docs/reference/camel/html/camel-CamelMimeFilterYenc.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/camel/html/camel-CamelMimeFilterYenc.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>CamelMimeFilterYenc</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Camel Reference Manual">
8
 
<link rel="up" href="StreamFilters.html" title="Stream Filters">
 
8
<link rel="up" href="Stream-Filters.html" title="Stream Filters">
9
9
<link rel="prev" href="camel-CamelMimeFilterWindows.html" title="CamelMimeFilterWindows">
10
10
<link rel="next" href="Services.html" title="Services">
11
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
15
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
16
<tr valign="middle">
17
17
<td><a accesskey="p" href="camel-CamelMimeFilterWindows.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="StreamFilters.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
18
<td><a accesskey="u" href="Stream-Filters.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
20
<th width="100%" align="center">Camel Reference Manual</th>
21
21
<td><a accesskey="n" href="Services.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
26
26
                  <a href="#camel-CamelMimeFilterYenc.description" class="shortcut">Description</a>
27
27
</td></tr>
28
28
</table>
29
 
<div class="refentry" lang="en">
 
29
<div class="refentry" title="CamelMimeFilterYenc">
30
30
<a name="camel-CamelMimeFilterYenc"></a><div class="titlepage"></div>
31
31
<div class="refnamediv"><table width="100%"><tr>
32
32
<td valign="top">
35
35
</td>
36
36
<td valign="top" align="right"></td>
37
37
</tr></table></div>
38
 
<div class="refsynopsisdiv">
 
38
<div class="refsynopsisdiv" title="Synopsis">
39
39
<a name="camel-CamelMimeFilterYenc.synopsis"></a><h2>Synopsis</h2>
40
40
<pre class="synopsis">                    <a class="link" href="camel-CamelMimeFilterYenc.html#CamelMimeFilterYenc" title="CamelMimeFilterYenc">CamelMimeFilterYenc</a>;
41
41
enum                <a class="link" href="camel-CamelMimeFilterYenc.html#CamelMimeFilterYencDirection" title="enum CamelMimeFilterYencDirection">CamelMimeFilterYencDirection</a>;
76
76
                                                         <em class="parameter"><code><span class="type">guint32</span> *crc</code></em>);
77
77
</pre>
78
78
</div>
79
 
<div class="refsect1" lang="en">
 
79
<div class="refsect1" title="Description">
80
80
<a name="camel-CamelMimeFilterYenc.description"></a><h2>Description</h2>
81
81
<p>
82
82
</p>
83
83
</div>
84
 
<div class="refsect1" lang="en">
 
84
<div class="refsect1" title="Details">
85
85
<a name="camel-CamelMimeFilterYenc.details"></a><h2>Details</h2>
86
 
<div class="refsect2" lang="en">
 
86
<div class="refsect2" title="CamelMimeFilterYenc">
87
87
<a name="CamelMimeFilterYenc"></a><h3>CamelMimeFilterYenc</h3>
88
88
<pre class="programlisting">typedef struct {
89
89
        CamelMimeFilter parent_object;
101
101
</p>
102
102
</div>
103
103
<hr>
104
 
<div class="refsect2" lang="en">
 
104
<div class="refsect2" title="enum CamelMimeFilterYencDirection">
105
105
<a name="CamelMimeFilterYencDirection"></a><h3>enum CamelMimeFilterYencDirection</h3>
106
106
<pre class="programlisting">typedef enum {
107
107
        CAMEL_MIME_FILTER_YENC_DIRECTION_ENCODE,
112
112
</p>
113
113
</div>
114
114
<hr>
115
 
<div class="refsect2" lang="en">
 
115
<div class="refsect2" title="CAMEL_MIME_YDECODE_STATE_INIT">
116
116
<a name="CAMEL-MIME-YDECODE-STATE-INIT:CAPS"></a><h3>CAMEL_MIME_YDECODE_STATE_INIT</h3>
117
117
<pre class="programlisting">#define CAMEL_MIME_YDECODE_STATE_INIT     (0)
118
118
</pre>
120
120
</p>
121
121
</div>
122
122
<hr>
123
 
<div class="refsect2" lang="en">
 
123
<div class="refsect2" title="CAMEL_MIME_YENCODE_STATE_INIT">
124
124
<a name="CAMEL-MIME-YENCODE-STATE-INIT:CAPS"></a><h3>CAMEL_MIME_YENCODE_STATE_INIT</h3>
125
125
<pre class="programlisting">#define CAMEL_MIME_YENCODE_STATE_INIT     (0)
126
126
</pre>
128
128
</p>
129
129
</div>
130
130
<hr>
131
 
<div class="refsect2" lang="en">
 
131
<div class="refsect2" title="CAMEL_MIME_YDECODE_STATE_EOLN">
132
132
<a name="CAMEL-MIME-YDECODE-STATE-EOLN:CAPS"></a><h3>CAMEL_MIME_YDECODE_STATE_EOLN</h3>
133
133
<pre class="programlisting">#define CAMEL_MIME_YDECODE_STATE_EOLN     (1 &lt;&lt; 8)
134
134
</pre>
136
136
</p>
137
137
</div>
138
138
<hr>
139
 
<div class="refsect2" lang="en">
 
139
<div class="refsect2" title="CAMEL_MIME_YDECODE_STATE_ESCAPE">
140
140
<a name="CAMEL-MIME-YDECODE-STATE-ESCAPE:CAPS"></a><h3>CAMEL_MIME_YDECODE_STATE_ESCAPE</h3>
141
141
<pre class="programlisting">#define CAMEL_MIME_YDECODE_STATE_ESCAPE   (1 &lt;&lt; 9)
142
142
</pre>
144
144
</p>
145
145
</div>
146
146
<hr>
147
 
<div class="refsect2" lang="en">
 
147
<div class="refsect2" title="CAMEL_MIME_YDECODE_STATE_BEGIN">
148
148
<a name="CAMEL-MIME-YDECODE-STATE-BEGIN:CAPS"></a><h3>CAMEL_MIME_YDECODE_STATE_BEGIN</h3>
149
149
<pre class="programlisting">#define CAMEL_MIME_YDECODE_STATE_BEGIN    (1 &lt;&lt; 12)
150
150
</pre>
152
152
</p>
153
153
</div>
154
154
<hr>
155
 
<div class="refsect2" lang="en">
 
155
<div class="refsect2" title="CAMEL_MIME_YDECODE_STATE_PART">
156
156
<a name="CAMEL-MIME-YDECODE-STATE-PART:CAPS"></a><h3>CAMEL_MIME_YDECODE_STATE_PART</h3>
157
157
<pre class="programlisting">#define CAMEL_MIME_YDECODE_STATE_PART     (1 &lt;&lt; 13)
158
158
</pre>
160
160
</p>
161
161
</div>
162
162
<hr>
163
 
<div class="refsect2" lang="en">
 
163
<div class="refsect2" title="CAMEL_MIME_YDECODE_STATE_DECODE">
164
164
<a name="CAMEL-MIME-YDECODE-STATE-DECODE:CAPS"></a><h3>CAMEL_MIME_YDECODE_STATE_DECODE</h3>
165
165
<pre class="programlisting">#define CAMEL_MIME_YDECODE_STATE_DECODE   (1 &lt;&lt; 14)
166
166
</pre>
168
168
</p>
169
169
</div>
170
170
<hr>
171
 
<div class="refsect2" lang="en">
 
171
<div class="refsect2" title="CAMEL_MIME_YDECODE_STATE_END">
172
172
<a name="CAMEL-MIME-YDECODE-STATE-END:CAPS"></a><h3>CAMEL_MIME_YDECODE_STATE_END</h3>
173
173
<pre class="programlisting">#define CAMEL_MIME_YDECODE_STATE_END      (1 &lt;&lt; 15)
174
174
</pre>
176
176
</p>
177
177
</div>
178
178
<hr>
179
 
<div class="refsect2" lang="en">
 
179
<div class="refsect2" title="CAMEL_MIME_YENCODE_CRC_INIT">
180
180
<a name="CAMEL-MIME-YENCODE-CRC-INIT:CAPS"></a><h3>CAMEL_MIME_YENCODE_CRC_INIT</h3>
181
181
<pre class="programlisting">#define CAMEL_MIME_YENCODE_CRC_INIT       (~0)
182
182
</pre>
184
184
</p>
185
185
</div>
186
186
<hr>
187
 
<div class="refsect2" lang="en">
 
187
<div class="refsect2" title="CAMEL_MIME_YENCODE_CRC_FINAL()">
188
188
<a name="CAMEL-MIME-YENCODE-CRC-FINAL:CAPS"></a><h3>CAMEL_MIME_YENCODE_CRC_FINAL()</h3>
189
189
<pre class="programlisting">#define CAMEL_MIME_YENCODE_CRC_FINAL(crc) (~crc)
190
190
</pre>
200
200
</table></div>
201
201
</div>
202
202
<hr>
203
 
<div class="refsect2" lang="en">
 
203
<div class="refsect2" title="camel_mime_filter_yenc_new ()">
204
204
<a name="camel-mime-filter-yenc-new"></a><h3>camel_mime_filter_yenc_new ()</h3>
205
205
<pre class="programlisting"><a class="link" href="camel-CamelMimeFilter.html#CamelMimeFilter" title="struct CamelMimeFilter"><span class="returnvalue">CamelMimeFilter</span></a> *   camel_mime_filter_yenc_new          (<em class="parameter"><code><a class="link" href="camel-CamelMimeFilterYenc.html#CamelMimeFilterYencDirection" title="enum CamelMimeFilterYencDirection"><span class="type">CamelMimeFilterYencDirection</span></a> direction</code></em>);</pre>
206
206
<p>
207
 
Create a new <a class="link" href="camel-CamelMimeFilterYenc.html#CamelMimeFilterYenc" title="CamelMimeFilterYenc"><span class="type">CamelMimeFilterYenc</span></a> filter object.</p>
 
207
Create a new <a class="link" href="camel-CamelMimeFilterYenc.html#CamelMimeFilterYenc" title="CamelMimeFilterYenc"><span class="type">CamelMimeFilterYenc</span></a> filter object.
 
208
</p>
208
209
<div class="variablelist"><table border="0">
209
210
<col align="left" valign="top">
210
211
<tbody>
222
223
</table></div>
223
224
</div>
224
225
<hr>
225
 
<div class="refsect2" lang="en">
 
226
<div class="refsect2" title="camel_mime_filter_yenc_set_state ()">
226
227
<a name="camel-mime-filter-yenc-set-state"></a><h3>camel_mime_filter_yenc_set_state ()</h3>
227
228
<pre class="programlisting"><span class="returnvalue">void</span>                camel_mime_filter_yenc_set_state    (<em class="parameter"><code><a class="link" href="camel-CamelMimeFilterYenc.html#CamelMimeFilterYenc" title="CamelMimeFilterYenc"><span class="type">CamelMimeFilterYenc</span></a> *yenc</code></em>,
228
229
                                                         <em class="parameter"><code><span class="type">gint</span> state</code></em>);</pre>
229
230
<p>
230
 
Sets the current state of the yencoder/ydecoder</p>
 
231
Sets the current state of the yencoder/ydecoder
 
232
</p>
231
233
<div class="variablelist"><table border="0">
232
234
<col align="left" valign="top">
233
235
<tbody>
245
247
</table></div>
246
248
</div>
247
249
<hr>
248
 
<div class="refsect2" lang="en">
 
250
<div class="refsect2" title="camel_mime_filter_yenc_set_crc ()">
249
251
<a name="camel-mime-filter-yenc-set-crc"></a><h3>camel_mime_filter_yenc_set_crc ()</h3>
250
252
<pre class="programlisting"><span class="returnvalue">void</span>                camel_mime_filter_yenc_set_crc      (<em class="parameter"><code><a class="link" href="camel-CamelMimeFilterYenc.html#CamelMimeFilterYenc" title="CamelMimeFilterYenc"><span class="type">CamelMimeFilterYenc</span></a> *yenc</code></em>,
251
253
                                                         <em class="parameter"><code><span class="type">guint32</span> crc</code></em>);</pre>
252
254
<p>
253
 
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>
 
255
Sets the current crc32 value on the yEnc filter <em class="parameter"><code>yenc</code></em> to <em class="parameter"><code>crc</code></em>.
 
256
</p>
254
257
<div class="variablelist"><table border="0">
255
258
<col align="left" valign="top">
256
259
<tbody>
268
271
</table></div>
269
272
</div>
270
273
<hr>
271
 
<div class="refsect2" lang="en">
 
274
<div class="refsect2" title="camel_mime_filter_yenc_get_pcrc ()">
272
275
<a name="camel-mime-filter-yenc-get-pcrc"></a><h3>camel_mime_filter_yenc_get_pcrc ()</h3>
273
276
<pre class="programlisting"><span class="returnvalue">guint32</span>             camel_mime_filter_yenc_get_pcrc     (<em class="parameter"><code><a class="link" href="camel-CamelMimeFilterYenc.html#CamelMimeFilterYenc" title="CamelMimeFilterYenc"><span class="type">CamelMimeFilterYenc</span></a> *yenc</code></em>);</pre>
274
277
<p>
275
 
Get the computed part crc or (<span class="type">guint32</span>) <code class="literal">-1</code> on fail.</p>
 
278
Get the computed part crc or (<span class="type">guint32</span>) <code class="literal">-1</code> on fail.
 
279
</p>
276
280
<div class="variablelist"><table border="0">
277
281
<col align="left" valign="top">
278
282
<tbody>
290
294
</table></div>
291
295
</div>
292
296
<hr>
293
 
<div class="refsect2" lang="en">
 
297
<div class="refsect2" title="camel_mime_filter_yenc_get_crc ()">
294
298
<a name="camel-mime-filter-yenc-get-crc"></a><h3>camel_mime_filter_yenc_get_crc ()</h3>
295
299
<pre class="programlisting"><span class="returnvalue">guint32</span>             camel_mime_filter_yenc_get_crc      (<em class="parameter"><code><a class="link" href="camel-CamelMimeFilterYenc.html#CamelMimeFilterYenc" title="CamelMimeFilterYenc"><span class="type">CamelMimeFilterYenc</span></a> *yenc</code></em>);</pre>
296
300
<p>
297
 
Get the computed crc or (<span class="type">guint32</span>) -1 on fail.</p>
 
301
Get the computed crc or (<span class="type">guint32</span>) -1 on fail.
 
302
</p>
298
303
<div class="variablelist"><table border="0">
299
304
<col align="left" valign="top">
300
305
<tbody>
312
317
</table></div>
313
318
</div>
314
319
<hr>
315
 
<div class="refsect2" lang="en">
 
320
<div class="refsect2" title="camel_ydecode_step ()">
316
321
<a name="camel-ydecode-step"></a><h3>camel_ydecode_step ()</h3>
317
322
<pre class="programlisting"><span class="returnvalue">gsize</span>               camel_ydecode_step                  (<em class="parameter"><code>const <span class="type">guchar</span> *in</code></em>,
318
323
                                                         <em class="parameter"><code><span class="type">gsize</span> inlen</code></em>,
330
335
(<em class="parameter"><code>pcrc</code></em>). If there are more parts, you should reuse <em class="parameter"><code>crc</code></em> without
331
336
re-initializing. Once all parts have been decoded, you may get the
332
337
combined crc32 value of all the parts using <a class="link" href="camel-CamelMimeFilterYenc.html#CAMEL-MIME-YENCODE-CRC-FINAL:CAPS" title="CAMEL_MIME_YENCODE_CRC_FINAL()"><span class="type">CAMEL_MIME_YENCODE_CRC_FINAL</span></a>
333
 
(<em class="parameter"><code>crc</code></em>).</p>
 
338
(<em class="parameter"><code>crc</code></em>).
 
339
</p>
334
340
<div class="variablelist"><table border="0">
335
341
<col align="left" valign="top">
336
342
<tbody>
373
379
</table></div>
374
380
</div>
375
381
<hr>
376
 
<div class="refsect2" lang="en">
 
382
<div class="refsect2" title="camel_yencode_step ()">
377
383
<a name="camel-yencode-step"></a><h3>camel_yencode_step ()</h3>
378
384
<pre class="programlisting"><span class="returnvalue">gsize</span>               camel_yencode_step                  (<em class="parameter"><code>const <span class="type">guchar</span> *in</code></em>,
379
385
                                                         <em class="parameter"><code><span class="type">gsize</span> inlen</code></em>,
392
398
</p>
393
399
<p>
394
400
Along the same lines, <em class="parameter"><code>pcrc</code></em> and <em class="parameter"><code>crc</code></em> should be initialized to
395
 
<a class="link" href="camel-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>
 
401
<a class="link" href="camel-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.
 
402
</p>
396
403
<div class="variablelist"><table border="0">
397
404
<col align="left" valign="top">
398
405
<tbody>
435
442
</table></div>
436
443
</div>
437
444
<hr>
438
 
<div class="refsect2" lang="en">
 
445
<div class="refsect2" title="camel_yencode_close ()">
439
446
<a name="camel-yencode-close"></a><h3>camel_yencode_close ()</h3>
440
447
<pre class="programlisting"><span class="returnvalue">gsize</span>               camel_yencode_close                 (<em class="parameter"><code>const <span class="type">guchar</span> *in</code></em>,
441
448
                                                         <em class="parameter"><code><span class="type">gsize</span> inlen</code></em>,
452
459
encoded "part". If there are more "parts" to encode, you should
453
460
re-use <em class="parameter"><code>crc</code></em> when encoding the next "parts" and then use
454
461
<a class="link" href="camel-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
455
 
all the parts.</p>
 
462
all the parts.
 
463
</p>
456
464
<div class="variablelist"><table border="0">
457
465
<col align="left" valign="top">
458
466
<tbody>