Initialize the gmime for upstream
[platform/upstream/gmime.git] / docs / reference / html / GMimeStreamNull.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>GMimeStreamNull</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="Streams.html" title="Streams">
9 <link rel="prev" href="GMimeStreamMmap.html" title="GMimeStreamMmap">
10 <link rel="next" href="GMimeStreamFilter.html" title="GMimeStreamFilter">
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="GMimeStreamMmap.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="Streams.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="GMimeStreamFilter.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="#GMimeStreamNull.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#GMimeStreamNull.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#GMimeStreamNull.object-hierarchy" class="shortcut">Object Hierarchy</a>
29 </td></tr>
30 </table>
31 <div class="refentry">
32 <a name="GMimeStreamNull"></a><div class="titlepage"></div>
33 <div class="refnamediv"><table width="100%"><tr>
34 <td valign="top">
35 <h2><span class="refentrytitle"><a name="GMimeStreamNull.top_of_page"></a>GMimeStreamNull</span></h2>
36 <p>GMimeStreamNull — A null stream</p>
37 </td>
38 <td valign="top" align="right"></td>
39 </tr></table></div>
40 <div class="refsynopsisdiv">
41 <a name="GMimeStreamNull.synopsis"></a><h2>Synopsis</h2>
42 <pre class="synopsis">struct              <a class="link" href="GMimeStreamNull.html#GMimeStreamNull-struct" title="struct GMimeStreamNull">GMimeStreamNull</a>;
43 <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       <a class="link" href="GMimeStreamNull.html#g-mime-stream-null-new" title="g_mime_stream_null_new ()">g_mime_stream_null_new</a>              (<em class="parameter"><code><span class="type">void</span></code></em>);
44 </pre>
45 </div>
46 <div class="refsect1">
47 <a name="GMimeStreamNull.object-hierarchy"></a><h2>Object Hierarchy</h2>
48 <pre class="synopsis">
49   GObject
50    +----<a class="link" href="GMimeStream.html" title="GMimeStream">GMimeStream</a>
51          +----GMimeStreamNull
52 </pre>
53 </div>
54 <div class="refsect1">
55 <a name="GMimeStreamNull.description"></a><h2>Description</h2>
56 <p>
57 A <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> which has no real backing storage at all. This
58 stream is useful for dry-runs and can also be useful for
59 determining statistics on source data which can be written to
60 streams but cannot be read as a stream itself (e.g. a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
61 via <a class="link" href="GMimeObject.html#g-mime-object-write-to-stream" title="g_mime_object_write_to_stream ()"><code class="function">g_mime_object_write_to_stream()</code></a>).
62 </p>
63 </div>
64 <div class="refsect1">
65 <a name="GMimeStreamNull.details"></a><h2>Details</h2>
66 <div class="refsect2">
67 <a name="GMimeStreamNull-struct"></a><h3>struct GMimeStreamNull</h3>
68 <pre class="programlisting">struct GMimeStreamNull;</pre>
69 <p>
70 A <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> which has no backing store.
71 </p>
72 <div class="variablelist"><table border="0">
73 <col align="left" valign="top">
74 <tbody></tbody>
75 </table></div>
76 </div>
77 <hr>
78 <div class="refsect2">
79 <a name="g-mime-stream-null-new"></a><h3>g_mime_stream_null_new ()</h3>
80 <pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       g_mime_stream_null_new              (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
81 <p>
82 Creates a new <a class="link" href="GMimeStreamNull.html" title="GMimeStreamNull"><span class="type">GMimeStreamNull</span></a> object.
83 </p>
84 <div class="variablelist"><table border="0">
85 <col align="left" valign="top">
86 <tbody><tr>
87 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
88 <td>a new null stream (similar to /dev/null on Unix).</td>
89 </tr></tbody>
90 </table></div>
91 </div>
92 </div>
93 <div class="refsect1">
94 <a name="GMimeStreamNull.see-also"></a><h2>See Also</h2>
95 <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a>
96 </div>
97 </div>
98 <div class="footer">
99 <hr>
100           Generated by GTK-Doc V1.18</div>
101 </body>
102 </html>