Initialize the gmime for upstream
[platform/upstream/gmime.git] / docs / reference / html / GMimeFilterGZip.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>GMimeFilterGZip</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="GMimeFilterFrom.html" title="GMimeFilterFrom">
10 <link rel="next" href="GMimeFilterHTML.html" title="GMimeFilterHTML">
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="GMimeFilterFrom.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="GMimeFilterHTML.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="#GMimeFilterGZip.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#GMimeFilterGZip.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#GMimeFilterGZip.object-hierarchy" class="shortcut">Object Hierarchy</a>
29 </td></tr>
30 </table>
31 <div class="refentry">
32 <a name="GMimeFilterGZip"></a><div class="titlepage"></div>
33 <div class="refnamediv"><table width="100%"><tr>
34 <td valign="top">
35 <h2><span class="refentrytitle"><a name="GMimeFilterGZip.top_of_page"></a>GMimeFilterGZip</span></h2>
36 <p>GMimeFilterGZip — GNU Zip compression/decompression</p>
37 </td>
38 <td valign="top" align="right"></td>
39 </tr></table></div>
40 <div class="refsynopsisdiv">
41 <a name="GMimeFilterGZip.synopsis"></a><h2>Synopsis</h2>
42 <pre class="synopsis">struct              <a class="link" href="GMimeFilterGZip.html#GMimeFilterGZip-struct" title="struct GMimeFilterGZip">GMimeFilterGZip</a>;
43 enum                <a class="link" href="GMimeFilterGZip.html#GMimeFilterGZipMode" title="enum GMimeFilterGZipMode">GMimeFilterGZipMode</a>;
44 <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> *       <a class="link" href="GMimeFilterGZip.html#g-mime-filter-gzip-new" title="g_mime_filter_gzip_new ()">g_mime_filter_gzip_new</a>              (<em class="parameter"><code><a class="link" href="GMimeFilterGZip.html#GMimeFilterGZipMode" title="enum GMimeFilterGZipMode"><span class="type">GMimeFilterGZipMode</span></a> mode</code></em>,
45                                                          <em class="parameter"><code><span class="type">int</span> level</code></em>);
46 </pre>
47 </div>
48 <div class="refsect1">
49 <a name="GMimeFilterGZip.object-hierarchy"></a><h2>Object Hierarchy</h2>
50 <pre class="synopsis">
51   GObject
52    +----<a class="link" href="GMimeFilter.html" title="GMimeFilter">GMimeFilter</a>
53          +----GMimeFilterGZip
54 </pre>
55 </div>
56 <div class="refsect1">
57 <a name="GMimeFilterGZip.description"></a><h2>Description</h2>
58 <p>
59 A <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> used for compressing or decompressing a stream using
60 GNU Zip.
61 </p>
62 </div>
63 <div class="refsect1">
64 <a name="GMimeFilterGZip.details"></a><h2>Details</h2>
65 <div class="refsect2">
66 <a name="GMimeFilterGZip-struct"></a><h3>struct GMimeFilterGZip</h3>
67 <pre class="programlisting">struct GMimeFilterGZip;</pre>
68 <p>
69 A filter for compresing or decompressing a gzip stream.
70 </p>
71 <div class="variablelist"><table border="0">
72 <col align="left" valign="top">
73 <tbody></tbody>
74 </table></div>
75 </div>
76 <hr>
77 <div class="refsect2">
78 <a name="GMimeFilterGZipMode"></a><h3>enum GMimeFilterGZipMode</h3>
79 <pre class="programlisting">typedef enum {
80         GMIME_FILTER_GZIP_MODE_ZIP,
81         GMIME_FILTER_GZIP_MODE_UNZIP
82 } GMimeFilterGZipMode;
83 </pre>
84 <p>
85 The mode for the <a class="link" href="GMimeFilterGZip.html" title="GMimeFilterGZip"><span class="type">GMimeFilterGZip</span></a> filter.
86 </p>
87 <div class="variablelist"><table border="0">
88 <col align="left" valign="top">
89 <tbody>
90 <tr>
91 <td><p><a name="GMIME-FILTER-GZIP-MODE-ZIP:CAPS"></a><span class="term"><code class="literal">GMIME_FILTER_GZIP_MODE_ZIP</code></span></p></td>
92 <td>Compress (zip) mode.
93 </td>
94 </tr>
95 <tr>
96 <td><p><a name="GMIME-FILTER-GZIP-MODE-UNZIP:CAPS"></a><span class="term"><code class="literal">GMIME_FILTER_GZIP_MODE_UNZIP</code></span></p></td>
97 <td>Uncompress (unzip) mode.
98 </td>
99 </tr>
100 </tbody>
101 </table></div>
102 </div>
103 <hr>
104 <div class="refsect2">
105 <a name="g-mime-filter-gzip-new"></a><h3>g_mime_filter_gzip_new ()</h3>
106 <pre class="programlisting"><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> *       g_mime_filter_gzip_new              (<em class="parameter"><code><a class="link" href="GMimeFilterGZip.html#GMimeFilterGZipMode" title="enum GMimeFilterGZipMode"><span class="type">GMimeFilterGZipMode</span></a> mode</code></em>,
107                                                          <em class="parameter"><code><span class="type">int</span> level</code></em>);</pre>
108 <p>
109 Creates a new gzip (or gunzip) filter.
110 </p>
111 <div class="variablelist"><table border="0">
112 <col align="left" valign="top">
113 <tbody>
114 <tr>
115 <td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
116 <td>zip or unzip</td>
117 </tr>
118 <tr>
119 <td><p><span class="term"><em class="parameter"><code>level</code></em> :</span></p></td>
120 <td>compression level</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 gzip (or gunzip) filter.</td>
125 </tr>
126 </tbody>
127 </table></div>
128 </div>
129 </div>
130 <div class="refsect1">
131 <a name="GMimeFilterGZip.see-also"></a><h2>See Also</h2>
132 <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a>
133 </div>
134 </div>
135 <div class="footer">
136 <hr>
137           Generated by GTK-Doc V1.18</div>
138 </body>
139 </html>