<refentry id="GMimeStreamNull">
<refmeta>
<refentrytitle role="top_of_page" id="GMimeStreamNull.top_of_page">GMimeStreamNull</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
  GMIME Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GMimeStreamNull</refname>
<refpurpose>A null stream</refpurpose>
</refnamediv>

<refsynopsisdiv id="GMimeStreamNull.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>                    <link linkend="GMimeStreamNull-struct">GMimeStreamNull</link>;
<link linkend="GMimeStream"><returnvalue>GMimeStream</returnvalue></link> *       <link linkend="g-mime-stream-null-new">g_mime_stream_null_new</link>              (<parameter><type>void</type></parameter>);
</synopsis>
</refsynopsisdiv>
<refsect1 id="GMimeStreamNull.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GMimeStream">GMimeStream</link>
         +----GMimeStreamNull
</synopsis>
</refsect1>

<refsect1 id="GMimeStreamNull.description" role="desc">
<title role="desc.title">Description</title>
<para>
A <link linkend="GMimeStream"><type>GMimeStream</type></link> which has no real backing storage at all. This
stream is useful for dry-runs and can also be useful for
determining statistics on source data which can be written to
streams but cannot be read as a stream itself (e.g. a <link linkend="GMimeObject"><type>GMimeObject</type></link>
via <link linkend="g-mime-object-write-to-stream"><function>g_mime_object_write_to_stream()</function></link>).
</para>
</refsect1>
<refsect1 id="GMimeStreamNull.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GMimeStreamNull-struct" role="struct">
<title>GMimeStreamNull</title>
<indexterm zone="GMimeStreamNull-struct"><primary>GMimeStreamNull</primary></indexterm>
<programlisting>typedef struct _GMimeStreamNull GMimeStreamNull;</programlisting>
<para>
A <link linkend="GMimeStream"><type>GMimeStream</type></link> which has no backing store.
</para><variablelist role="struct">
</variablelist></refsect2>
<refsect2 id="g-mime-stream-null-new" role="function">
<title>g_mime_stream_null_new ()</title>
<indexterm zone="g-mime-stream-null-new"><primary>g_mime_stream_null_new</primary></indexterm>
<programlisting><link linkend="GMimeStream"><returnvalue>GMimeStream</returnvalue></link> *       g_mime_stream_null_new              (<parameter><type>void</type></parameter>);</programlisting>
<para>
Creates a new <link linkend="GMimeStreamNull"><type>GMimeStreamNull</type></link> object.
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new null stream (similar to /dev/null on Unix).
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 id="GMimeStreamNull.see-also">
<title>See Also</title>
<link linkend="GMimeStream"><type>GMimeStream</type></link>
</refsect1>

</refentry>
