blob: 664d50e7b2f47fb7370ed1e364ff6f44af967317 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GSimpleIOStream: GIO Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.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="GIOStream.html" title="GIOStream">
<link rel="next" href="GFileInputStream.html" title="GFileInputStream">
<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
<a href="#GSimpleIOStream.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
<a href="#GSimpleIOStream.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
<a href="#GSimpleIOStream.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="streaming.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GIOStream.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GFileInputStream.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GSimpleIOStream"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GSimpleIOStream.top_of_page"></a>GSimpleIOStream</span></h2>
<p>GSimpleIOStream — A wrapper around an input and an output stream.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GSimpleIOStream.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody><tr>
<td class="function_type">
<a class="link" href="GIOStream.html" title="GIOStream"><span class="returnvalue">GIOStream</span></a> *
</td>
<td class="function_name">
<a class="link" href="GSimpleIOStream.html#g-simple-io-stream-new" title="g_simple_io_stream_new ()">g_simple_io_stream_new</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GSimpleIOStream.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a> *</td>
<td class="property_name"><a class="link" href="GSimpleIOStream.html#GSimpleIOStream--input-stream" title="The “input-stream” property">input-stream</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="GOutputStream.html" title="GOutputStream"><span class="type">GOutputStream</span></a> *</td>
<td class="property_name"><a class="link" href="GSimpleIOStream.html#GSimpleIOStream--output-stream" title="The “output-stream” property">output-stream</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GSimpleIOStream.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GSimpleIOStream.html#GSimpleIOStream-struct" title="GSimpleIOStream">GSimpleIOStream</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GSimpleIOStream.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="../gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a class="link" href="GIOStream.html" title="GIOStream">GIOStream</a>
<span class="lineart">╰──</span> GSimpleIOStream
</pre>
</div>
<div class="refsect1">
<a name="GSimpleIOStream.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gio/gio.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GSimpleIOStream.description"></a><h2>Description</h2>
<p>GSimpleIOStream creates a <a class="link" href="GIOStream.html" title="GIOStream"><span class="type">GIOStream</span></a> from an arbitrary <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a> and
<a class="link" href="GOutputStream.html" title="GOutputStream"><span class="type">GOutputStream</span></a>. This allows any pair of input and output streams to be used
with <a class="link" href="GIOStream.html" title="GIOStream"><span class="type">GIOStream</span></a> methods.</p>
<p>This is useful when you obtained a <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a> and a <a class="link" href="GOutputStream.html" title="GOutputStream"><span class="type">GOutputStream</span></a>
by other means, for instance creating them with platform specific methods as
<a class="link" href="GUnixInputStream.html#g-unix-input-stream-new" title="g_unix_input_stream_new ()"><code class="function">g_unix_input_stream_new()</code></a> or <a class="link" href="gio-GWin32InputStream.html#g-win32-input-stream-new" title="g_win32_input_stream_new ()"><code class="function">g_win32_input_stream_new()</code></a>, and you want
to take advantage of the methods provided by <a class="link" href="GIOStream.html" title="GIOStream"><span class="type">GIOStream</span></a>.</p>
</div>
<div class="refsect1">
<a name="GSimpleIOStream.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="g-simple-io-stream-new"></a><h3>g_simple_io_stream_new ()</h3>
<pre class="programlisting"><a class="link" href="GIOStream.html" title="GIOStream"><span class="returnvalue">GIOStream</span></a> *
g_simple_io_stream_new (<em class="parameter"><code><a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a> *input_stream</code></em>,
<em class="parameter"><code><a class="link" href="GOutputStream.html" title="GOutputStream"><span class="type">GOutputStream</span></a> *output_stream</code></em>);</pre>
<p>Creates a new <a class="link" href="GSimpleIOStream.html" title="GSimpleIOStream"><span class="type">GSimpleIOStream</span></a> wrapping <em class="parameter"><code>input_stream</code></em>
and <em class="parameter"><code>output_stream</code></em>
.
See also <a class="link" href="GIOStream.html" title="GIOStream"><span class="type">GIOStream</span></a>.</p>
<div class="refsect3">
<a name="g-simple-io-stream-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>input_stream</p></td>
<td class="parameter_description"><p>a <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>output_stream</p></td>
<td class="parameter_description"><p>a <a class="link" href="GOutputStream.html" title="GOutputStream"><span class="type">GOutputStream</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-simple-io-stream-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GSimpleIOStream.html" title="GSimpleIOStream"><span class="type">GSimpleIOStream</span></a> instance.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-44.html#api-index-2.44">2.44</a></p>
</div>
</div>
<div class="refsect1">
<a name="GSimpleIOStream.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GSimpleIOStream-struct"></a><h3>GSimpleIOStream</h3>
<pre class="programlisting">typedef struct _GSimpleIOStream GSimpleIOStream;</pre>
<p>A wrapper around a <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a> and a <a class="link" href="GOutputStream.html" title="GOutputStream"><span class="type">GOutputStream</span></a>.</p>
<p class="since">Since: <a class="link" href="api-index-2-44.html#api-index-2.44">2.44</a></p>
</div>
</div>
<div class="refsect1">
<a name="GSimpleIOStream.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GSimpleIOStream--input-stream"></a><h3>The <code class="literal">“input-stream”</code> property</h3>
<pre class="programlisting"> “input-stream” <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a> *</pre>
<p>The GInputStream to read from.</p>
<p>Flags: Read / Write / Construct Only</p>
<p class="since">Since: <a class="link" href="api-index-2-44.html#api-index-2.44">2.44</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GSimpleIOStream--output-stream"></a><h3>The <code class="literal">“output-stream”</code> property</h3>
<pre class="programlisting"> “output-stream” <a class="link" href="GOutputStream.html" title="GOutputStream"><span class="type">GOutputStream</span></a> *</pre>
<p>The GOutputStream to write to.</p>
<p>Flags: Read / Write / Construct Only</p>
<p class="since">Since: <a class="link" href="api-index-2-44.html#api-index-2.44">2.44</a></p>
</div>
</div>
<div class="refsect1">
<a name="GSimpleIOStream.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GIOStream.html" title="GIOStream"><span class="type">GIOStream</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>