<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GFilterInputStream</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GIO Reference Manual">
<link rel="up" href="streaming.html" title="Streaming I/O">
<link rel="prev" href="GFileDescriptorBased.html" title="GFileDescriptorBased">
<link rel="next" href="GFilterOutputStream.html" title="GFilterOutputStream">
-<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
+<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
-<link rel="part" href="pt01.html" title="Part I. GIO Overview">
-<link rel="chapter" href="ch01.html" title="Introduction">
-<link rel="chapter" href="ch02.html" title="Compiling GIO applications">
-<link rel="chapter" href="ch03.html" title="Running GIO applications">
-<link rel="chapter" href="extending-gio.html" title="Extending GIO">
-<link rel="part" href="pt02.html" title="Part II. API Reference">
-<link rel="chapter" href="file_ops.html" title="File Operations">
-<link rel="chapter" href="file_mon.html" title="File System Monitoring">
-<link rel="chapter" href="async.html" title="Asynchronous I/O">
-<link rel="chapter" href="conversion.html" title="Data conversion">
-<link rel="chapter" href="streaming.html" title="Streaming I/O">
-<link rel="chapter" href="types.html" title="File types and applications">
-<link rel="chapter" href="volume_mon.html" title="Volumes and Drives">
-<link rel="chapter" href="icons.html" title="Icons">
-<link rel="chapter" href="failable_initialization.html" title="Failable Initialization">
-<link rel="chapter" href="networking.html" title="Lowlevel platform-independent network support">
-<link rel="chapter" href="resolver.html" title="DNS resolution">
-<link rel="chapter" href="highlevel-socket.html" title="Highlevel network functionallity">
-<link rel="chapter" href="utils.html" title="Utilities">
-<link rel="chapter" href="extending.html" title="Extending GIO">
-<link rel="part" href="migrating.html" title="Part III. Migrating to GIO">
-<link rel="chapter" href="ch19.html" title="Migrating from POSIX to GIO">
-<link rel="chapter" href="ch20.html" title="Migrating from GnomeVFS to GIO">
-<link rel="chapter" href="gio-hierarchy.html" title="Object Hierarchy">
-<link rel="index" href="api-index-full.html" title="Index">
-<link rel="index" href="api-index-deprecated.html" title="Index of deprecated symbols">
-<link rel="index" href="api-index-2-18.html" title="Index of new symbols in 2.18">
-<link rel="index" href="api-index-2-20.html" title="Index of new symbols in 2.20">
-<link rel="index" href="api-index-2-22.html" title="Index of new symbols in 2.22">
-<link rel="index" href="api-index-2-24.html" title="Index of new symbols in 2.24">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<a href="#GFilterInputStream.properties" class="shortcut">Properties</a>
</td></tr>
</table>
-<div class="refentry" title="GFilterInputStream">
+<div class="refentry">
<a name="GFilterInputStream"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
</td>
<td valign="top" align="right"></td>
</tr></table></div>
-<div class="refsynopsisdiv" title="Synopsis">
+<div class="refsynopsisdiv">
<a name="GFilterInputStream.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <gio/gio.h>
<a class="link" href="GFilterInputStream.html#GFilterInputStream-struct" title="GFilterInputStream">GFilterInputStream</a>;
<a class="link" href="GInputStream.html" title="GInputStream"><span class="returnvalue">GInputStream</span></a> * <a class="link" href="GFilterInputStream.html#g-filter-input-stream-get-base-stream" title="g_filter_input_stream_get_base_stream ()">g_filter_input_stream_get_base_stream</a>
- (<a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="returnvalue">GFilterInputStream</span></a> *stream);
-<a href="
http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GFilterInputStream.html#g-filter-input-stream-get-close-base-stream" title="g_filter_input_stream_get_close_base_stream ()">g_filter_input_stream_get_close_base_stream</a>
- (<a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="returnvalue">GFilterInputStream</span></a> *stream);
+ (<em class="parameter"><code><a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="type">GFilterInputStream</span></a> *stream</code></em>);
+<a href="
./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GFilterInputStream.html#g-filter-input-stream-get-close-base-stream" title="g_filter_input_stream_get_close_base_stream ()">g_filter_input_stream_get_close_base_stream</a>
+ (<em class="parameter"><code><a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="type">GFilterInputStream</span></a> *stream</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GFilterInputStream.html#g-filter-input-stream-set-close-base-stream" title="g_filter_input_stream_set_close_base_stream ()">g_filter_input_stream_set_close_base_stream</a>
- (<a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="returnvalue">GFilterInputStream</span></a> *stream,
- <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> close_base);
+ (<em class="parameter"><code><a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="type">GFilterInputStream</span></a> *stream</code></em>,
+ <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> close_base</code></em>);
</pre>
</div>
-<div class="refsect1" title="Object Hierarchy">
+<div class="refsect1">
<a name="GFilterInputStream.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
- <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+ <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a>
+----GFilterInputStream
+----<a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a>
+----<a class="link" href="gio-GConverterInputstream.html#GConverterInputStream">GConverterInputStream</a>
</pre>
</div>
-<div class="refsect1" title="Properties">
+<div class="refsect1">
<a name="GFilterInputStream.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GFilterInputStream.html#GFilterInputStream--base-stream" title='The "base-stream" property'>base-stream</a>" <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>* : Read / Write / Construct Only
- "<a class="link" href="GFilterInputStream.html#GFilterInputStream--close-base-stream" title='The "close-base-stream" property'>close-base-stream</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct Only
+ "<a class="link" href="GFilterInputStream.html#GFilterInputStream--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
</pre>
</div>
-<div class="refsect1" title="Description">
+<div class="refsect1">
<a name="GFilterInputStream.description"></a><h2>Description</h2>
+<p>
+Base class for input stream implementations that perform some
+kind of filtering operation on a base stream. Typical examples
+of filtering operations are character set conversion, compression
+and byte order flipping.
+</p>
</div>
-<div class="refsect1" title="Details">
+<div class="refsect1">
<a name="GFilterInputStream.details"></a><h2>Details</h2>
-<div class="refsect2" title="GFilterInputStream">
+<div class="refsect2">
<a name="GFilterInputStream-struct"></a><h3>GFilterInputStream</h3>
<pre class="programlisting">typedef struct _GFilterInputStream GFilterInputStream;</pre>
<p>
-A base class for all input streams that work on an underlying stream.</p>
+A base class for all input streams that work on an underlying stream.
+</p>
</div>
<hr>
-<div class="refsect2" title="g_filter_input_stream_get_base_stream ()">
+<div class="refsect2">
<a name="g-filter-input-stream-get-base-stream"></a><h3>g_filter_input_stream_get_base_stream ()</h3>
<pre class="programlisting"><a class="link" href="GInputStream.html" title="GInputStream"><span class="returnvalue">GInputStream</span></a> * g_filter_input_stream_get_base_stream
- (<a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="returnvalue">GFilterInputStream</span></a> *stream);</pre>
+ (<em class="parameter"><code><a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="type">GFilterInputStream</span></a> *stream</code></em>);</pre>
<p>
-Gets the base stream for the filter stream.</p>
+Gets the base stream for the filter stream.
+</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
-<td> a <a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="type">GFilterInputStream</span></a>.
-</td>
+<td>a <a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="type">GFilterInputStream</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
-<td> a <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>.
+<td>a <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
-<div class="refsect2" title="g_filter_input_stream_get_close_base_stream ()">
+<div class="refsect2">
<a name="g-filter-input-stream-get-close-base-stream"></a><h3>g_filter_input_stream_get_close_base_stream ()</h3>
-<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> g_filter_input_stream_get_close_base_stream
- (<a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="returnvalue">GFilterInputStream</span></a> *stream);</pre>
+<pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> g_filter_input_stream_get_close_base_stream
+ (<em class="parameter"><code><a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="type">GFilterInputStream</span></a> *stream</code></em>);</pre>
<p>
Returns whether the base stream will be closed when <em class="parameter"><code>stream</code></em> is
-closed.</p>
+closed.
+</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
-<td> a <a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="type">GFilterInputStream</span></a>.
-</td>
+<td>a <a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="type">GFilterInputStream</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
-<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the base stream will be closed.
-</td>
+<td>
+<a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the base stream will be closed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
-<div class="refsect2" title="g_filter_input_stream_set_close_base_stream ()">
+<div class="refsect2">
<a name="g-filter-input-stream-set-close-base-stream"></a><h3>g_filter_input_stream_set_close_base_stream ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> g_filter_input_stream_set_close_base_stream
- (<a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="returnvalue">GFilterInputStream</span></a> *stream,
- <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> close_base);</pre>
+ (<em class="parameter"><code><a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="type">GFilterInputStream</span></a> *stream</code></em>,
+ <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> close_base</code></em>);</pre>
<p>
-Sets whether the base stream will be closed when <em class="parameter"><code>stream</code></em> is closed.</p>
+Sets whether the base stream will be closed when <em class="parameter"><code>stream</code></em> is closed.
+</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
-<td> a <a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="type">GFilterInputStream</span></a>.
-</td>
+<td>a <a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="type">GFilterInputStream</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>close_base</code></em> :</span></p></td>
-<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to close the base stream.
-</td>
+<td>
+<a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to close the base stream.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
-<div class="refsect1" title="Property Details">
+<div class="refsect1">
<a name="GFilterInputStream.property-details"></a><h2>Property Details</h2>
-<div class="refsect2" title='The "base-stream" property'>
+<div class="refsect2">
<a name="GFilterInputStream--base-stream"></a><h3>The <code class="literal">"base-stream"</code> property</h3>
<pre class="programlisting"> "base-stream" <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>* : Read / Write / Construct Only</pre>
<p>The underlying base stream on which the io ops will be done.</p>
</div>
<hr>
-<div class="refsect2" title='The "close-base-stream" property'>
+<div class="refsect2">
<a name="GFilterInputStream--close-base-stream"></a><h3>The <code class="literal">"close-base-stream"</code> property</h3>
-<pre class="programlisting"> "close-base-stream" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct Only</pre>
+<pre class="programlisting"> "close-base-stream" <a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct</pre>
<p>If the base stream should be closed when the filter stream is closed.</p>
<p>Default value: TRUE</p>
</div>
</div>
<div class="footer">
<hr>
- Generated by GTK-Doc V1.13</div>
+ Generated by GTK-Doc V1.18</div>
</body>
</html>
\ No newline at end of file
projects / platform / upstream / glib2.0.git / blobdiff