docs/reference/gio/html/GFilterOutputStream.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>GFilterOutputStream</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GIO Reference Manual">
   8 <link rel="up" href="streaming.html" title="Streaming I/O">
   9 <link rel="prev" href="GFilterInputStream.html" title="GFilterInputStream">
  10 <link rel="next" href="GMemoryInputStream.html" title="GMemoryInputStream">
  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="GFilterInputStream.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="streaming.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">GIO Reference Manual</th>
  21 <td><a accesskey="n" href="GMemoryInputStream.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="#GFilterOutputStream.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GFilterOutputStream.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GFilterOutputStream.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#GFilterOutputStream.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="GFilterOutputStream"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="GFilterOutputStream.top_of_page"></a>GFilterOutputStream</span></h2>
  38 <p>GFilterOutputStream — Filter Output Stream</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="GFilterOutputStream.synopsis"></a><h2>Synopsis</h2>
  44 <pre class="synopsis">
  45 #include &lt;gio/gio.h&gt;
  46
  47                     <a class="link" href="GFilterOutputStream.html#GFilterOutputStream-struct" title="GFilterOutputStream">GFilterOutputStream</a>;
  48 <a class="link" href="GOutputStream.html" title="GOutputStream"><span class="returnvalue">GOutputStream</span></a> *     <a class="link" href="GFilterOutputStream.html#g-filter-output-stream-get-base-stream" title="g_filter_output_stream_get_base_stream ()">g_filter_output_stream_get_base_stream</a>
  49                                                         (<em class="parameter"><code><a class="link" href="GFilterOutputStream.html" title="GFilterOutputStream"><span class="type">GFilterOutputStream</span></a> *stream</code></em>);
  50 <a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GFilterOutputStream.html#g-filter-output-stream-get-close-base-stream" title="g_filter_output_stream_get_close_base_stream ()">g_filter_output_stream_get_close_base_stream</a>
  51                                                         (<em class="parameter"><code><a class="link" href="GFilterOutputStream.html" title="GFilterOutputStream"><span class="type">GFilterOutputStream</span></a> *stream</code></em>);
  52 <span class="returnvalue">void</span>                <a class="link" href="GFilterOutputStream.html#g-filter-output-stream-set-close-base-stream" title="g_filter_output_stream_set_close_base_stream ()">g_filter_output_stream_set_close_base_stream</a>
  53                                                         (<em class="parameter"><code><a class="link" href="GFilterOutputStream.html" title="GFilterOutputStream"><span class="type">GFilterOutputStream</span></a> *stream</code></em>,
  54                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> close_base</code></em>);
  55 </pre>
  56 </div>
  57 <div class="refsect1">
  58 <a name="GFilterOutputStream.object-hierarchy"></a><h2>Object Hierarchy</h2>
  59 <pre class="synopsis">
  60   <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  61    +----<a class="link" href="GOutputStream.html" title="GOutputStream">GOutputStream</a>
  62          +----GFilterOutputStream
  63                +----<a class="link" href="GBufferedOutputStream.html" title="GBufferedOutputStream">GBufferedOutputStream</a>
  64                +----<a class="link" href="gio-GConverterOutputstream.html#GConverterOutputStream">GConverterOutputStream</a>
  65                +----<a class="link" href="GDataOutputStream.html" title="GDataOutputStream">GDataOutputStream</a>
  66 </pre>
  67 </div>
  68 <div class="refsect1">
  69 <a name="GFilterOutputStream.properties"></a><h2>Properties</h2>
  70 <pre class="synopsis">
  71   "<a class="link" href="GFilterOutputStream.html#GFilterOutputStream--base-stream" title='The "base-stream" property'>base-stream</a>"              <a class="link" href="GOutputStream.html" title="GOutputStream"><span class="type">GOutputStream</span></a>*        : Read / Write / Construct Only
  72   "<a class="link" href="GFilterOutputStream.html#GFilterOutputStream--close-base-stream" title='The "close-base-stream" property'>close-base-stream</a>"        <a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct Only
  73 </pre>
  74 </div>
  75 <div class="refsect1">
  76 <a name="GFilterOutputStream.description"></a><h2>Description</h2>
  77 <p>
  78 Base class for output stream implementations that perform some
  79 kind of filtering operation on a base stream. Typical examples
  80 of filtering operations are character set conversion, compression
  81 and byte order flipping.
  82 </p>
  83 </div>
  84 <div class="refsect1">
  85 <a name="GFilterOutputStream.details"></a><h2>Details</h2>
  86 <div class="refsect2">
  87 <a name="GFilterOutputStream-struct"></a><h3>GFilterOutputStream</h3>
  88 <pre class="programlisting">typedef struct _GFilterOutputStream GFilterOutputStream;</pre>
  89 <p>
  90 A base class for all output streams that work on an underlying stream.
  91 </p>
  92 </div>
  93 <hr>
  94 <div class="refsect2">
  95 <a name="g-filter-output-stream-get-base-stream"></a><h3>g_filter_output_stream_get_base_stream ()</h3>
  96 <pre class="programlisting"><a class="link" href="GOutputStream.html" title="GOutputStream"><span class="returnvalue">GOutputStream</span></a> *     g_filter_output_stream_get_base_stream
  97                                                         (<em class="parameter"><code><a class="link" href="GFilterOutputStream.html" title="GFilterOutputStream"><span class="type">GFilterOutputStream</span></a> *stream</code></em>);</pre>
  98 <p>
  99 Gets the base stream for the filter stream.
 100 </p>
 101 <div class="variablelist"><table border="0">
 102 <col align="left" valign="top">
 103 <tbody>
 104 <tr>
 105 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 106 <td>a <a class="link" href="GFilterOutputStream.html" title="GFilterOutputStream"><span class="type">GFilterOutputStream</span></a>.</td>
 107 </tr>
 108 <tr>
 109 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 110 <td>a <a class="link" href="GOutputStream.html" title="GOutputStream"><span class="type">GOutputStream</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 111 </td>
 112 </tr>
 113 </tbody>
 114 </table></div>
 115 </div>
 116 <hr>
 117 <div class="refsect2">
 118 <a name="g-filter-output-stream-get-close-base-stream"></a><h3>g_filter_output_stream_get_close_base_stream ()</h3>
 119 <pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_filter_output_stream_get_close_base_stream
 120                                                         (<em class="parameter"><code><a class="link" href="GFilterOutputStream.html" title="GFilterOutputStream"><span class="type">GFilterOutputStream</span></a> *stream</code></em>);</pre>
 121 <p>
 122 Returns whether the base stream will be closed when <em class="parameter"><code>stream</code></em> is
 123 closed.
 124 </p>
 125 <div class="variablelist"><table border="0">
 126 <col align="left" valign="top">
 127 <tbody>
 128 <tr>
 129 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 130 <td>a <a class="link" href="GFilterOutputStream.html" title="GFilterOutputStream"><span class="type">GFilterOutputStream</span></a>.</td>
 131 </tr>
 132 <tr>
 133 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 134 <td>
 135 <a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the base stream will be closed.</td>
 136 </tr>
 137 </tbody>
 138 </table></div>
 139 </div>
 140 <hr>
 141 <div class="refsect2">
 142 <a name="g-filter-output-stream-set-close-base-stream"></a><h3>g_filter_output_stream_set_close_base_stream ()</h3>
 143 <pre class="programlisting"><span class="returnvalue">void</span>                g_filter_output_stream_set_close_base_stream
 144                                                         (<em class="parameter"><code><a class="link" href="GFilterOutputStream.html" title="GFilterOutputStream"><span class="type">GFilterOutputStream</span></a> *stream</code></em>,
 145                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> close_base</code></em>);</pre>
 146 <p>
 147 Sets whether the base stream will be closed when <em class="parameter"><code>stream</code></em> is closed.
 148 </p>
 149 <div class="variablelist"><table border="0">
 150 <col align="left" valign="top">
 151 <tbody>
 152 <tr>
 153 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 154 <td>a <a class="link" href="GFilterOutputStream.html" title="GFilterOutputStream"><span class="type">GFilterOutputStream</span></a>.</td>
 155 </tr>
 156 <tr>
 157 <td><p><span class="term"><em class="parameter"><code>close_base</code></em> :</span></p></td>
 158 <td>
 159 <a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to close the base stream.</td>
 160 </tr>
 161 </tbody>
 162 </table></div>
 163 </div>
 164 </div>
 165 <div class="refsect1">
 166 <a name="GFilterOutputStream.property-details"></a><h2>Property Details</h2>
 167 <div class="refsect2">
 168 <a name="GFilterOutputStream--base-stream"></a><h3>The <code class="literal">"base-stream"</code> property</h3>
 169 <pre class="programlisting">  "base-stream"              <a class="link" href="GOutputStream.html" title="GOutputStream"><span class="type">GOutputStream</span></a>*        : Read / Write / Construct Only</pre>
 170 <p>The underlying base stream on which the io ops will be done.</p>
 171 </div>
 172 <hr>
 173 <div class="refsect2">
 174 <a name="GFilterOutputStream--close-base-stream"></a><h3>The <code class="literal">"close-base-stream"</code> property</h3>
 175 <pre class="programlisting">  "close-base-stream"        <a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct Only</pre>
 176 <p>If the base stream should be closed when the filter stream is closed.</p>
 177 <p>Default value: TRUE</p>
 178 </div>
 179 </div>
 180 </div>
 181 <div class="footer">
 182 <hr>
 183           Generated by GTK-Doc V1.18</div>
 184 </body>
 185 </html>