<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>glibmm 2.4: Gio::OutputStream Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%">
<tr>
<td width="10%" height="40"><img src="../../images/gtkmm_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td>
<td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td>
</tr>
</table>
<center>
<a class="qindex" href="../../../../gtkmm-2.4/docs/index.html">Main Page</a>
<a href="../../../../gtkmm-2.4/docs/reference/html/group__Widgets.html">Widgets</a>
<a class="qindex" href="namespaces.html">glibmm Namespaces</a>
<a href="../../../../gtkmm-2.4/docs/tutorial/html/index.html"> Book</a>
</center>
<hr width="100%"/>
<!-- begin main content -->
<div id="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="nav">
<a class="el" href="namespaceGio.html">Gio</a>::<a class="el" href="classGio_1_1OutputStream.html">OutputStream</a></div>
<h1>Gio::OutputStream Class Reference<br>
<small>
[<a class="el" href="group__Streams.html">Stream Classes</a>]</small>
</h1><!-- doxytag: class="Gio::OutputStream" --><!-- doxytag: inherits="Glib::Object" -->Base class for implementing streaming output.
<a href="#_details">More...</a>
<p>
<div class="dynheader">
Inheritance diagram for Gio::OutputStream:</div>
<div class="dynsection">
<p><center><img src="classGio_1_1OutputStream__inherit__graph.png" border="0" usemap="#Gio_1_1OutputStream__inherit__map" alt="Inheritance graph"></center>
<map name="Gio_1_1OutputStream__inherit__map">
<area shape="rect" href="classGio_1_1FileOutputStream.html" title="FileOutputStream provides output streams that write their content to a file." alt="" coords="5,316,171,343"><area shape="rect" href="classGio_1_1FilterOutputStream.html" title="Filter Output Stream." alt="" coords="195,316,371,343"><area shape="rect" href="classGio_1_1UnixOutputStream.html" title="UnixOutputStream implements OutputStream for writing to a a unix file descriptor..." alt="" coords="395,316,568,343"><area shape="rect" href="classGlib_1_1Object.html" title="Glib::Object" alt="" coords="236,161,329,188"><area shape="rect" href="classGlib_1_1ObjectBase.html" title="Glib::ObjectBase is a common base class for Objects and Interfaces." alt="" coords="220,84,345,111"><area shape="rect" href="classsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="227,7,339,33"><area shape="rect" href="classGio_1_1BufferedOutputStream.html" title="The buffered output stream implements FilterOutputStream and provides for buffered..." alt="" coords="181,393,384,420"><area shape="rect" href="classGio_1_1DataOutputStream.html" title="An implementation of BufferedOutputStream that allows for high-level data manipulation..." alt="" coords="195,471,371,497"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classGio_1_1OutputStream-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#e03f14924981183936d800fcde857fea">~OutputStream</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GOutputStream* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#c5a71a1f432f8ac2a53de2c66eb81d9d">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#c5a71a1f432f8ac2a53de2c66eb81d9d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const GOutputStream* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#c29e6ad7ccffde24201a1da608f25ac9">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#c29e6ad7ccffde24201a1da608f25ac9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GOutputStream* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#d9128985ea683716db40d7831cb7075c">gobj_copy</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#d9128985ea683716db40d7831cb7075c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">gssize </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#0a714bc357db90c5e34f1d001446fe29">write</a> (const void* buffer, gsize count, const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& cancellable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tries to write <em>count</em> bytes from <em>buffer</em> into the stream. <a href="#0a714bc357db90c5e34f1d001446fe29"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">gssize </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#5037c7a24ba87c7e8f1992f7586f032c">write</a> (const void* buffer, gsize count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tries to write <em>count</em> bytes from <em>buffer</em> into the stream. <a href="#5037c7a24ba87c7e8f1992f7586f032c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">gssize </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#ee589585890960b4c26c86865fe3f0b4">write</a> (const <a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__string.html">std::string</a>& buffer, const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& cancellable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tries to write <em>count</em> bytes from <em>buffer</em> into the stream. <a href="#ee589585890960b4c26c86865fe3f0b4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">gssize </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#fa3cf9f1b7006b1f79d8e452616f3324">write</a> (const <a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__string.html">std::string</a>& buffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tries to write <em>count</em> bytes from <em>buffer</em> into the stream. <a href="#fa3cf9f1b7006b1f79d8e452616f3324"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#c9ff8d59409bfdfdfd95643f3ee4c98d">write_all</a> (const void* buffer, gsize count, gsize& bytes_written, const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& cancellable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tries to write <em>count</em> bytes from <em>buffer</em> into the stream. <a href="#c9ff8d59409bfdfdfd95643f3ee4c98d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#ca15317cfd772d712b44147d378788b8">write_all</a> (const void* buffer, gsize count, gsize& bytes_written)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tries to write <em>count</em> bytes from <em>buffer</em> into the stream. <a href="#ca15317cfd772d712b44147d378788b8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#c10263d00bf17a158d4aad207fbb2d64">write_all</a> (const <a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__string.html">std::string</a>& buffer, gsize& bytes_written, const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& cancellable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tries to write <em>count</em> bytes from <em>buffer</em> into the stream. <a href="#c10263d00bf17a158d4aad207fbb2d64"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#9171833c0c7c88103afd3fc12efbcf17">write_all</a> (const <a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__string.html">std::string</a>& buffer, gsize& bytes_written)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tries to write <em>count</em> bytes from <em>buffer</em> into the stream. <a href="#9171833c0c7c88103afd3fc12efbcf17"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">gssize </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#080bff3f1f2017b4d4ff8343a5bfbf15">splice</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1InputStream.html">InputStream</a>>& source, const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& cancellable, <a class="el" href="group__giommEnums.html#g7c30d67e5f60d33fdcd3053123feea74">OutputStreamSpliceFlags</a> flags=OUTPUT_STREAM_SPLICE_NONE)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Splices an input stream into an output stream. <a href="#080bff3f1f2017b4d4ff8343a5bfbf15"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">gssize </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#aca5a5891175c7c66cb77e476bae1843">splice</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1InputStream.html">InputStream</a>>& source, <a class="el" href="group__giommEnums.html#g7c30d67e5f60d33fdcd3053123feea74">OutputStreamSpliceFlags</a> flags=OUTPUT_STREAM_SPLICE_NONE)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Splices an input stream into an output stream. <a href="#aca5a5891175c7c66cb77e476bae1843"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#413a349600ecd6013d15f563d6c6fd85">flush</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& cancellable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flushed any outstanding buffers in the stream. <a href="#413a349600ecd6013d15f563d6c6fd85"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#6bb81a11ef79dc8ffa9f5a275d2d6e0c">flush</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flushed any outstanding buffers in the stream. <a href="#6bb81a11ef79dc8ffa9f5a275d2d6e0c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#4fefad6d6b244924b4fe51c105d3805c">close</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& cancellable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes the stream, releasing resources related to it. <a href="#4fefad6d6b244924b4fe51c105d3805c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#c3e92678425dd530b22eaab97852ca23">close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes the stream, releasing resources related to it. <a href="#c3e92678425dd530b22eaab97852ca23"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#947eefdb85b9081348a1c0cc04be2eaa">write_async</a> (const void* buffer, gsize count, const <a class="el" href="namespaceGio.html#ecaa02709f9ab83fa2b36d2571665cbe">SlotAsyncReady</a>& slot, const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& cancellable, int io_priority=Glib::PRIORITY_DEFAULT)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request an asynchronous write of <em>count</em> bytes from <em>buffer</em> into the stream. <a href="#947eefdb85b9081348a1c0cc04be2eaa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#ae0f58d27908beb35f24a88b6254107a">write_async</a> (const void* buffer, gsize count, const <a class="el" href="namespaceGio.html#ecaa02709f9ab83fa2b36d2571665cbe">SlotAsyncReady</a>& slot, int io_priority=Glib::PRIORITY_DEFAULT)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request an asynchronous write of <em>count</em> bytes from <em>buffer</em> into the stream. <a href="#ae0f58d27908beb35f24a88b6254107a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">gssize </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#c61dbaa1f910c14bf3beaadc0498065f">write_finish</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1AsyncResult.html">AsyncResult</a>>& result)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finishes a stream write operation. <a href="#c61dbaa1f910c14bf3beaadc0498065f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#4bfe08685268b2236362bce84ba1cc77">splice_async</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1InputStream.html">InputStream</a>>& source, const <a class="el" href="namespaceGio.html#ecaa02709f9ab83fa2b36d2571665cbe">SlotAsyncReady</a>& slot, const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& cancellable, <a class="el" href="group__giommEnums.html#g7c30d67e5f60d33fdcd3053123feea74">OutputStreamSpliceFlags</a> flags=OUTPUT_STREAM_SPLICE_NONE, int io_priority=Glib::PRIORITY_DEFAULT)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Splices a stream asynchronously. <a href="#4bfe08685268b2236362bce84ba1cc77"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#85e95838d577180e11831b0f149e8f5c">splice_async</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1InputStream.html">InputStream</a>>& source, const <a class="el" href="namespaceGio.html#ecaa02709f9ab83fa2b36d2571665cbe">SlotAsyncReady</a>& slot, <a class="el" href="group__giommEnums.html#g7c30d67e5f60d33fdcd3053123feea74">OutputStreamSpliceFlags</a> flags=OUTPUT_STREAM_SPLICE_NONE, int io_priority=Glib::PRIORITY_DEFAULT)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Splices a stream asynchronously. <a href="#85e95838d577180e11831b0f149e8f5c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">gssize </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#29461238b7b3cf9c2d6dde85b4a6a6ea">splice_finish</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1AsyncResult.html">AsyncResult</a>>& result)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finishes an asynchronous stream splice operation. <a href="#29461238b7b3cf9c2d6dde85b4a6a6ea"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#c76478281be9559cb0a924bcc4ead263">flush_async</a> (const <a class="el" href="namespaceGio.html#ecaa02709f9ab83fa2b36d2571665cbe">SlotAsyncReady</a>& slot, const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& cancellable, int io_priority=Glib::PRIORITY_DEFAULT)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flushes a stream asynchronously. <a href="#c76478281be9559cb0a924bcc4ead263"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#a82f241b6c72fef632eaf51b279b25ce">flush_async</a> (const <a class="el" href="namespaceGio.html#ecaa02709f9ab83fa2b36d2571665cbe">SlotAsyncReady</a>& slot, int io_priority=Glib::PRIORITY_DEFAULT)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flushes a stream asynchronously. <a href="#a82f241b6c72fef632eaf51b279b25ce"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#f2e8a3c48152c2fdc744a50016911a3a">flush_finish</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1AsyncResult.html">AsyncResult</a>>& result)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finishes flushing an output stream. <a href="#f2e8a3c48152c2fdc744a50016911a3a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#47fb0dbd7f88c9167dacd577dcd8c6c7">close_async</a> (const <a class="el" href="namespaceGio.html#ecaa02709f9ab83fa2b36d2571665cbe">SlotAsyncReady</a>& slot, const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& cancellable, int io_priority=Glib::PRIORITY_DEFAULT)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Requests an asynchronous close of the stream, releasing resources related to it. <a href="#47fb0dbd7f88c9167dacd577dcd8c6c7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#92f6a9cc67bfa6a2356a031fb3f691c0">close_async</a> (const <a class="el" href="namespaceGio.html#ecaa02709f9ab83fa2b36d2571665cbe">SlotAsyncReady</a>& slot, int io_priority=Glib::PRIORITY_DEFAULT)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Requests an asynchronous close of the stream, releasing resources related to it. <a href="#92f6a9cc67bfa6a2356a031fb3f691c0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#8db5ee9e7a3a0c091eeebe960550e6f5">close_finish</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1AsyncResult.html">AsyncResult</a>>& result)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes an output stream. <a href="#8db5ee9e7a3a0c091eeebe960550e6f5"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><br>
<<a class="el" href="classGio_1_1OutputStream.html">Gio::OutputStream</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1OutputStream.html#96aad4c49fb938a88b75abe5339bef4f">wrap</a> (GOutputStream* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="el" href="namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#96aad4c49fb938a88b75abe5339bef4f"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Base class for implementing streaming output.
<p>
<dl compact><dt><b><a class="el" href="newin2p16s.html#_newin2p16s000040">Since glibmm 2.16:</a></b></dt><dd></dd></dl>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="e03f14924981183936d800fcde857fea"></a><!-- doxytag: member="Gio::OutputStream::~OutputStream" ref="e03f14924981183936d800fcde857fea" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gio::OutputStream::~OutputStream </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c5a71a1f432f8ac2a53de2c66eb81d9d"></a><!-- doxytag: member="Gio::OutputStream::gobj" ref="c5a71a1f432f8ac2a53de2c66eb81d9d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GOutputStream* Gio::OutputStream::gobj </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C GObject.
<p>
<p>Reimplemented from <a class="el" href="classGlib_1_1ObjectBase.html#4c6efc18be8cb9c56e58fc0bd20fafbe">Glib::ObjectBase</a>.</p>
<p>Reimplemented in <a class="el" href="classGio_1_1BufferedOutputStream.html#6dfd09a0501267ef81030e3cf8e9ae47">Gio::BufferedOutputStream</a>, <a class="el" href="classGio_1_1DataOutputStream.html#cf92da9c162b7a0805aabe334912d5cb">Gio::DataOutputStream</a>, <a class="el" href="classGio_1_1FileOutputStream.html#a69b1c94c5a3a2e0002fc6cf5127fc70">Gio::FileOutputStream</a>, <a class="el" href="classGio_1_1FilterOutputStream.html#7cf09c946f16c1597e7ce038fd64f9ef">Gio::FilterOutputStream</a>, and <a class="el" href="classGio_1_1UnixOutputStream.html#c22d258873e88661e29140587687d1d7">Gio::UnixOutputStream</a>.</p>
</div>
</div><p>
<a class="anchor" name="c29e6ad7ccffde24201a1da608f25ac9"></a><!-- doxytag: member="Gio::OutputStream::gobj" ref="c29e6ad7ccffde24201a1da608f25ac9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GOutputStream* Gio::OutputStream::gobj </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C GObject.
<p>
<p>Reimplemented from <a class="el" href="classGlib_1_1ObjectBase.html#778a94181132976bbfb0519793f3b32e">Glib::ObjectBase</a>.</p>
<p>Reimplemented in <a class="el" href="classGio_1_1BufferedOutputStream.html#4a906daf7be02fd1c1548253f5f0e95c">Gio::BufferedOutputStream</a>, <a class="el" href="classGio_1_1DataOutputStream.html#42d4127b7b7b16ae6ec3feb5f66b68d2">Gio::DataOutputStream</a>, <a class="el" href="classGio_1_1FileOutputStream.html#2bf847a5064b01e671731ecd56f88968">Gio::FileOutputStream</a>, <a class="el" href="classGio_1_1FilterOutputStream.html#4497fb9f0cb87f953bbc8fa5bb218a0c">Gio::FilterOutputStream</a>, and <a class="el" href="classGio_1_1UnixOutputStream.html#b9e89719d791ca893290ef5074fe2cf7">Gio::UnixOutputStream</a>.</p>
</div>
</div><p>
<a class="anchor" name="d9128985ea683716db40d7831cb7075c"></a><!-- doxytag: member="Gio::OutputStream::gobj_copy" ref="d9128985ea683716db40d7831cb7075c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GOutputStream* Gio::OutputStream::gobj_copy </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
<p>
<p>Reimplemented in <a class="el" href="classGio_1_1BufferedOutputStream.html#890c12d13d9f87332b00b785e32e4424">Gio::BufferedOutputStream</a>, <a class="el" href="classGio_1_1DataOutputStream.html#c1e10167167a2f5c894e567003483419">Gio::DataOutputStream</a>, <a class="el" href="classGio_1_1FileOutputStream.html#f536865a9ed17c3093ab67465fba908b">Gio::FileOutputStream</a>, <a class="el" href="classGio_1_1FilterOutputStream.html#e0701328a1b8b2e71ba15dcdb83422b6">Gio::FilterOutputStream</a>, and <a class="el" href="classGio_1_1UnixOutputStream.html#9d24719266d36067e08320d597f84f0d">Gio::UnixOutputStream</a>.</p>
</div>
</div><p>
<a class="anchor" name="0a714bc357db90c5e34f1d001446fe29"></a><!-- doxytag: member="Gio::OutputStream::write" ref="0a714bc357db90c5e34f1d001446fe29" args="(const void *buffer, gsize count, const Glib::RefPtr< Cancellable > &cancellable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gssize Gio::OutputStream::write </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gsize </td>
<td class="paramname"> <em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& </td>
<td class="paramname"> <em>cancellable</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tries to write <em>count</em> bytes from <em>buffer</em> into the stream.
<p>
Will block during the operation.<p>
If count is zero returns zero and does nothing. A value of <em>count</em> larger than MAXSSIZE will cause a <a class="el" href="classGio_1_1Error.html" title="Exception class for giomm errors.">Gio::Error</a> with INVALID_ARGUMENT to be thrown.<p>
On success, the number of bytes written to the stream is returned. It is not an error if this is not the same as the requested size, as it can happen e.g. on a partial i/o error, or if there is not enough storage in the stream. All writes either block until at least one byte is written, so zero is never returned (unless <em>count</em> is zero).<p>
The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, a <a class="el" href="classGio_1_1Error.html" title="Exception class for giomm errors.">Gio::Error</a> will be thrown with CANCELLED. If an operation was partially finished when the operation was cancelled the partial result will be returned, without an error. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>The buffer containing the data to write. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>The number of bytes to write. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cancellable</em> </td><td><a class="el" href="classGio_1_1Cancellable.html" title="Allows actions to be cancelled.">Cancellable</a> object. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of bytes written, or -1 on error. </dd></dl>
</div>
</div><p>
<a class="anchor" name="5037c7a24ba87c7e8f1992f7586f032c"></a><!-- doxytag: member="Gio::OutputStream::write" ref="5037c7a24ba87c7e8f1992f7586f032c" args="(const void *buffer, gsize count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gssize Gio::OutputStream::write </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gsize </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tries to write <em>count</em> bytes from <em>buffer</em> into the stream.
<p>
Will block during the operation.<p>
If count is zero returns zero and does nothing. A value of <em>count</em> larger than MAXSSIZE will cause a <a class="el" href="classGio_1_1Error.html" title="Exception class for giomm errors.">Gio::Error</a> with INVALID_ARGUMENT to be thrown.<p>
On success, the number of bytes written to the stream is returned. It is not an error if this is not the same as the requested size, as it can happen e.g. on a partial i/o error, or if the there is not enough storage in the stream. All writes either block until at least one byte is written, so zero is never returned (unless <em>count</em> is zero).<p>
On error -1 is returned. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>The buffer containing the data to write. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>The number of bytes to write. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of bytes written, or -1 on error. </dd></dl>
</div>
</div><p>
<a class="anchor" name="ee589585890960b4c26c86865fe3f0b4"></a><!-- doxytag: member="Gio::OutputStream::write" ref="ee589585890960b4c26c86865fe3f0b4" args="(const std::string &buffer, const Glib::RefPtr< Cancellable > &cancellable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gssize Gio::OutputStream::write </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__string.html">std::string</a> & </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& </td>
<td class="paramname"> <em>cancellable</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tries to write <em>count</em> bytes from <em>buffer</em> into the stream.
<p>
Will block during the operation.<p>
If count is zero returns zero and does nothing. A value of <em>count</em> larger than MAXSSIZE will cause a <a class="el" href="classGio_1_1Error.html" title="Exception class for giomm errors.">Gio::Error</a> with INVALID_ARGUMENT to be thrown.<p>
On success, the number of bytes written to the stream is returned. It is not an error if this is not the same as the requested size, as it can happen e.g. on a partial i/o error, or if the there is not enough storage in the stream. All writes either block until at least one byte is written, so zero is never returned (unless <em>count</em> is zero).<p>
On error -1 is returned. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>The buffer containing the data to write. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cancellable</em> </td><td><a class="el" href="classGio_1_1Cancellable.html" title="Allows actions to be cancelled.">Cancellable</a> object. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of bytes written, or -1 on error. </dd></dl>
</div>
</div><p>
<a class="anchor" name="fa3cf9f1b7006b1f79d8e452616f3324"></a><!-- doxytag: member="Gio::OutputStream::write" ref="fa3cf9f1b7006b1f79d8e452616f3324" args="(const std::string &buffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gssize Gio::OutputStream::write </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__string.html">std::string</a> & </td>
<td class="paramname"> <em>buffer</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tries to write <em>count</em> bytes from <em>buffer</em> into the stream.
<p>
Will block during the operation.<p>
If string that is larger than MAXSSIZE bytes will cause a <a class="el" href="classGio_1_1Error.html" title="Exception class for giomm errors.">Gio::Error</a> with INVALID_ARGUMENT to be thrown.<p>
On success, the number of bytes written to the stream is returned. It is not an error if this is not the same as the requested size, as it can happen e.g. on a partial i/o error, or if the there is not enough storage in the stream. All writes either block until at least one byte is written, so zero is never returned (unless <em>count</em> is zero).<p>
On error -1 is returned. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>The buffer containing the data to write. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of bytes written, or -1 on error. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c9ff8d59409bfdfdfd95643f3ee4c98d"></a><!-- doxytag: member="Gio::OutputStream::write_all" ref="c9ff8d59409bfdfdfd95643f3ee4c98d" args="(const void *buffer, gsize count, gsize &bytes_written, const Glib::RefPtr< Cancellable > &cancellable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gio::OutputStream::write_all </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gsize </td>
<td class="paramname"> <em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gsize & </td>
<td class="paramname"> <em>bytes_written</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& </td>
<td class="paramname"> <em>cancellable</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tries to write <em>count</em> bytes from <em>buffer</em> into the stream.
<p>
Will block during the operation.<p>
This function is similar to g_output_stream_write(), except it tries to write as many bytes as requested, only stopping on an error.<p>
On a successful write of <em>count</em> bytes, <code>true</code> is returned, and <em>bytes_written</em> is set to <em>count</em>.<p>
If there is an error during the operation <code>false</code> is returned and <em>error</em> is set to indicate the error status, <em>bytes_written</em> is updated to contain the number of bytes written into the stream before the error occurred. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>The buffer containing the data to write. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>The number of bytes to write. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bytes_written</em> </td><td>Location to store the number of bytes that was written to the stream. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cancellable</em> </td><td>Optional <a class="el" href="classGio_1_1Cancellable.html" title="Allows actions to be cancelled.">Cancellable</a> object, <code>0</code> to ignore. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> on success, <code>false</code> if there was an error. </dd></dl>
</div>
</div><p>
<a class="anchor" name="ca15317cfd772d712b44147d378788b8"></a><!-- doxytag: member="Gio::OutputStream::write_all" ref="ca15317cfd772d712b44147d378788b8" args="(const void *buffer, gsize count, gsize &bytes_written)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gio::OutputStream::write_all </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gsize </td>
<td class="paramname"> <em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gsize & </td>
<td class="paramname"> <em>bytes_written</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tries to write <em>count</em> bytes from <em>buffer</em> into the stream.
<p>
Will block during the operation.<p>
This function is similar to <a class="el" href="classGio_1_1OutputStream.html#0a714bc357db90c5e34f1d001446fe29" title="Tries to write count bytes from buffer into the stream.">write()</a>, except it tries to write as many bytes as requested, only stopping on an error.<p>
On a successful write of <em>count</em> bytes, <code>true</code> is returned, and <em>bytes_written</em> is set to <em>count</em> .<p>
If there is an error during the operation <code>false</code> is returned and <em>error</em> is set to indicate the error status, <em>bytes_written</em> is updated to contain the number of bytes written into the stream before the error occured. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>The buffer containing the data to write. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>The number of bytes to write. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bytes_written</em> </td><td>Location to store the number of bytes that was written to the stream. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> on success, <code>false</code> if there was an error. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c10263d00bf17a158d4aad207fbb2d64"></a><!-- doxytag: member="Gio::OutputStream::write_all" ref="c10263d00bf17a158d4aad207fbb2d64" args="(const std::string &buffer, gsize &bytes_written, const Glib::RefPtr< Cancellable > &cancellable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gio::OutputStream::write_all </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__string.html">std::string</a> & </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gsize & </td>
<td class="paramname"> <em>bytes_written</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& </td>
<td class="paramname"> <em>cancellable</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tries to write <em>count</em> bytes from <em>buffer</em> into the stream.
<p>
Will block during the operation.<p>
This function is similar to <a class="el" href="classGio_1_1OutputStream.html#0a714bc357db90c5e34f1d001446fe29" title="Tries to write count bytes from buffer into the stream.">write()</a>, except it tries to write as many bytes as requested, only stopping on an error.<p>
On a successful write of <em>count</em> bytes, <code>true</code> is returned, and <em>bytes_written</em> is set to <em>count</em> .<p>
If there is an error during the operation <code>false</code> is returned and <em>error</em> is set to indicate the error status, <em>bytes_written</em> is updated to contain the number of bytes written into the stream before the error occured. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>The buffer containing the data to write. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bytes_written</em> </td><td>Location to store the number of bytes that was written to the stream. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cancellable</em> </td><td><a class="el" href="classGio_1_1Cancellable.html" title="Allows actions to be cancelled.">Cancellable</a> object. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> on success, <code>false</code> if there was an error. </dd></dl>
</div>
</div><p>
<a class="anchor" name="9171833c0c7c88103afd3fc12efbcf17"></a><!-- doxytag: member="Gio::OutputStream::write_all" ref="9171833c0c7c88103afd3fc12efbcf17" args="(const std::string &buffer, gsize &bytes_written)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gio::OutputStream::write_all </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__string.html">std::string</a> & </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gsize & </td>
<td class="paramname"> <em>bytes_written</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tries to write <em>count</em> bytes from <em>buffer</em> into the stream.
<p>
Will block during the operation.<p>
This function is similar to <a class="el" href="classGio_1_1OutputStream.html#0a714bc357db90c5e34f1d001446fe29" title="Tries to write count bytes from buffer into the stream.">write()</a>, except it tries to write as many bytes as requested, only stopping on an error.<p>
On a successful write of <em>count</em> bytes, <code>true</code> is returned, and <em>bytes_written</em> is set to <em>count</em> .<p>
If there is an error during the operation <code>false</code> is returned and <em>error</em> is set to indicate the error status, <em>bytes_written</em> is updated to contain the number of bytes written into the stream before the error occured. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>The buffer containing the data to write. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bytes_written</em> </td><td>Location to store the number of bytes that was written to the stream. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> on success, <code>false</code> if there was an error. </dd></dl>
</div>
</div><p>
<a class="anchor" name="080bff3f1f2017b4d4ff8343a5bfbf15"></a><!-- doxytag: member="Gio::OutputStream::splice" ref="080bff3f1f2017b4d4ff8343a5bfbf15" args="(const Glib::RefPtr< InputStream > &source, const Glib::RefPtr< Cancellable > &cancellable, OutputStreamSpliceFlags flags=OUTPUT_STREAM_SPLICE_NONE)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gssize Gio::OutputStream::splice </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1InputStream.html">InputStream</a>>& </td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& </td>
<td class="paramname"> <em>cancellable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__giommEnums.html#g7c30d67e5f60d33fdcd3053123feea74">OutputStreamSpliceFlags</a> </td>
<td class="paramname"> <em>flags</em> = <code>OUTPUT_STREAM_SPLICE_NONE</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Splices an input stream into an output stream.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>An <a class="el" href="classGio_1_1InputStream.html" title="Base class for implementing streaming input.">InputStream</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>flags</em> </td><td>A set of OutputStreamSpliceFlags. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cancellable</em> </td><td>A <a class="el" href="classGio_1_1Cancellable.html" title="Allows actions to be cancelled.">Cancellable</a> object. ignore. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A gssize containing the size of the data spliced. </dd></dl>
</div>
</div><p>
<a class="anchor" name="aca5a5891175c7c66cb77e476bae1843"></a><!-- doxytag: member="Gio::OutputStream::splice" ref="aca5a5891175c7c66cb77e476bae1843" args="(const Glib::RefPtr< InputStream > &source, OutputStreamSpliceFlags flags=OUTPUT_STREAM_SPLICE_NONE)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gssize Gio::OutputStream::splice </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1InputStream.html">InputStream</a>>& </td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__giommEnums.html#g7c30d67e5f60d33fdcd3053123feea74">OutputStreamSpliceFlags</a> </td>
<td class="paramname"> <em>flags</em> = <code>OUTPUT_STREAM_SPLICE_NONE</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Splices an input stream into an output stream.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>An <a class="el" href="classGio_1_1InputStream.html" title="Base class for implementing streaming input.">InputStream</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>flags</em> </td><td>A set of OutputStreamSpliceFlags. ignore. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A gssize containing the size of the data spliced. </dd></dl>
</div>
</div><p>
<a class="anchor" name="413a349600ecd6013d15f563d6c6fd85"></a><!-- doxytag: member="Gio::OutputStream::flush" ref="413a349600ecd6013d15f563d6c6fd85" args="(const Glib::RefPtr< Cancellable > &cancellable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gio::OutputStream::flush </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& </td>
<td class="paramname"> <em>cancellable</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Flushed any outstanding buffers in the stream.
<p>
Will block during the operation. Closing the stream will implicitly cause a flush.<p>
This function is optional for inherited classes.<p>
The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, a <a class="el" href="classGio_1_1Error.html" title="Exception class for giomm errors.">Gio::Error</a> will be thrown with CANCELLED. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cancellable</em> </td><td><a class="el" href="classGio_1_1Cancellable.html" title="Allows actions to be cancelled.">Cancellable</a> object. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> on success, <code>false</code> on error. </dd></dl>
</div>
</div><p>
<a class="anchor" name="6bb81a11ef79dc8ffa9f5a275d2d6e0c"></a><!-- doxytag: member="Gio::OutputStream::flush" ref="6bb81a11ef79dc8ffa9f5a275d2d6e0c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gio::OutputStream::flush </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Flushed any outstanding buffers in the stream.
<p>
Will block during the operation. Closing the stream will implicitly cause a flush.<p>
This function is optional for inherited classes.<p>
The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, a <a class="el" href="classGio_1_1Error.html" title="Exception class for giomm errors.">Gio::Error</a> with CANCELLED will be thrown. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cancellable</em> </td><td>Optional cancellable object. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> on success, <code>false</code> on error. </dd></dl>
</div>
</div><p>
<a class="anchor" name="4fefad6d6b244924b4fe51c105d3805c"></a><!-- doxytag: member="Gio::OutputStream::close" ref="4fefad6d6b244924b4fe51c105d3805c" args="(const Glib::RefPtr< Cancellable > &cancellable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gio::OutputStream::close </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& </td>
<td class="paramname"> <em>cancellable</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Closes the stream, releasing resources related to it.
<p>
Once the stream is closed, all other operations will throw a <a class="el" href="classGio_1_1Error.html" title="Exception class for giomm errors.">Gio::Error</a> with CLOSED. Closing a stream multiple times will not cause an error to be thrown.<p>
Closing a stream will automatically flush any outstanding buffers in the stream.<p>
Streams will be automatically closed when the last reference is dropped, but you might want to call this function to make sure resources are released as early as possible.<p>
Some streams might keep the backing store of the stream (e.g. a file descriptor) open after the stream is closed. See the documentation for the individual stream for details.<p>
On failure the first error that happened will be reported, but the close operation will finish as much as possible. A stream that failed to close will still throw a <a class="el" href="classGio_1_1Error.html" title="Exception class for giomm errors.">Gio::Error</a> with CLOSED for all operations. Still, it is important to check and report the error to the user, otherwise there might be a loss of data as all data might not be written.<p>
The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, a <a class="el" href="classGio_1_1Error.html" title="Exception class for giomm errors.">Gio::Error</a> will be thrown with CANCELLED. Cancelling a close will still leave the stream closed, but there some streams can use a faster close that doesn't block to e.g. check errors. On cancellation (as with any error) there is no guarantee that all written data will reach the target. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cancellable</em> </td><td><a class="el" href="classGio_1_1Cancellable.html" title="Allows actions to be cancelled.">Cancellable</a> object. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> on success, <code>false</code> on failure. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c3e92678425dd530b22eaab97852ca23"></a><!-- doxytag: member="Gio::OutputStream::close" ref="c3e92678425dd530b22eaab97852ca23" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gio::OutputStream::close </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Closes the stream, releasing resources related to it.
<p>
Once the stream is closed, all other operations will throw a <a class="el" href="classGio_1_1Error.html" title="Exception class for giomm errors.">Gio::Error</a> with CLOSED. Closing a stream multiple times will not return an error.<p>
Closing a stream will automatically flush any outstanding buffers in the stream.<p>
Streams will be automatically closed when the last reference is dropped, but you might want to call make sure resources are released as early as possible.<p>
Some streams might keep the backing store of the stream (e.g. a file descriptor) open after the stream is closed. See the documentation for the individual stream for details.<p>
On failure the first error that happened will be reported, but the close operation will finish as much as possible. A stream that failed to close will still throw a <a class="el" href="classGio_1_1Error.html" title="Exception class for giomm errors.">Gio::Error</a> with CLOSED for all operations. Still, it is important to check and report the error to the user, otherwise there might be a loss of data as all data might not be written.<p>
The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, a <a class="el" href="classGio_1_1Error.html" title="Exception class for giomm errors.">Gio::Error</a> with CANCELLED will be thrown. Cancelling a close will still leave the stream closed, but there some streams can use a faster close that doesn't block to e.g. check errors. On cancellation (as with any error) there is no guarantee that all written data will reach the target. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cancellable</em> </td><td>Optional cancellable object. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> on success, <code>false</code> on failure. </dd></dl>
</div>
</div><p>
<a class="anchor" name="947eefdb85b9081348a1c0cc04be2eaa"></a><!-- doxytag: member="Gio::OutputStream::write_async" ref="947eefdb85b9081348a1c0cc04be2eaa" args="(const void *buffer, gsize count, const SlotAsyncReady &slot, const Glib::RefPtr< Cancellable > &cancellable, int io_priority=Glib::PRIORITY_DEFAULT)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gio::OutputStream::write_async </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gsize </td>
<td class="paramname"> <em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespaceGio.html#ecaa02709f9ab83fa2b36d2571665cbe">SlotAsyncReady</a>& </td>
<td class="paramname"> <em>slot</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& </td>
<td class="paramname"> <em>cancellable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>io_priority</em> = <code>Glib::PRIORITY_DEFAULT</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Request an asynchronous write of <em>count</em> bytes from <em>buffer</em> into the stream.
<p>
When the operation is finished <em>slot</em> will be called. You can then call <a class="el" href="classGio_1_1OutputStream.html#c61dbaa1f910c14bf3beaadc0498065f" title="Finishes a stream write operation.">write_finish()</a> to get the result of the operation.<p>
During an async request no other sync and async calls are allowed, and will result in <a class="el" href="classGio_1_1Error.html" title="Exception class for giomm errors.">Gio::Error</a> with PENDING being thrown.<p>
A value of <em>count</em> larger than MAXSSIZE will cause a <a class="el" href="classGio_1_1Error.html" title="Exception class for giomm errors.">Gio::Error</a> with NVALID_ARGUMENT to be thrown.<p>
On success, the number of bytes written will be passed to the callback <em>slot</em>. It is not an error if this is not the same as the requested size, as it can happen e.g. on a partial I/O error, but generally we try to write as many bytes as requested.<p>
Any outstanding I/O request with higher priority (lower numerical value) will be executed before an outstanding request with lower priority. Default priority is <a class="el" href="namespaceGlib.html#0c450f82b9e34689e2dda2038ba7834f597ed3aa6067516c9c752896f3816b5e">Glib::PRIORITY_DEFAULT</a>.<p>
The asyncronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one you must override all.<p>
For the synchronous, blocking version of this function, see <a class="el" href="classGio_1_1OutputStream.html#0a714bc357db90c5e34f1d001446fe29" title="Tries to write count bytes from buffer into the stream.">write()</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>The buffer containing the data to write. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>The number of bytes to write </td></tr>
<tr><td valign="top"></td><td valign="top"><em>slot</em> </td><td>Callback slot to call when the request is satisfied. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cancellable</em> </td><td><a class="el" href="classGio_1_1Cancellable.html" title="Allows actions to be cancelled.">Cancellable</a> object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>io_priority</em> </td><td>The io priority of the request. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="ae0f58d27908beb35f24a88b6254107a"></a><!-- doxytag: member="Gio::OutputStream::write_async" ref="ae0f58d27908beb35f24a88b6254107a" args="(const void *buffer, gsize count, const SlotAsyncReady &slot, int io_priority=Glib::PRIORITY_DEFAULT)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gio::OutputStream::write_async </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gsize </td>
<td class="paramname"> <em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespaceGio.html#ecaa02709f9ab83fa2b36d2571665cbe">SlotAsyncReady</a>& </td>
<td class="paramname"> <em>slot</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>io_priority</em> = <code>Glib::PRIORITY_DEFAULT</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Request an asynchronous write of <em>count</em> bytes from <em>buffer</em> into the stream.
<p>
When the operation is finished <em>slot</em> will be called. You can then call <a class="el" href="classGio_1_1OutputStream.html#c61dbaa1f910c14bf3beaadc0498065f" title="Finishes a stream write operation.">write_finish()</a> to get the result of the operation.<p>
During an async request no other sync and async calls are allowed, and will result in <a class="el" href="classGio_1_1Error.html" title="Exception class for giomm errors.">Gio::Error</a> with PENDING being thrown.<p>
A value of <em>count</em> larger than MAXSSIZE will cause a <a class="el" href="classGio_1_1Error.html" title="Exception class for giomm errors.">Gio::Error</a> with INVALID_ARGUMENT to be thrown.<p>
On success, the number of bytes written will be passed to the callback <em>slot</em>. It is not an error if this is not the same as the requested size, as it can happen e.g. on a partial I/O error, but generally we try to write as many bytes as requested.<p>
Any outstanding I/O request with higher priority (lower numerical value) will be executed before an outstanding request with lower priority. Default priority is <a class="el" href="namespaceGlib.html#0c450f82b9e34689e2dda2038ba7834f597ed3aa6067516c9c752896f3816b5e">Glib::PRIORITY_DEFAULT</a>.<p>
The asyncronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one you must override all.<p>
For the synchronous, blocking version of this function, see <a class="el" href="classGio_1_1OutputStream.html#0a714bc357db90c5e34f1d001446fe29" title="Tries to write count bytes from buffer into the stream.">write()</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>The buffer containing the data to write. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>The number of bytes to write </td></tr>
<tr><td valign="top"></td><td valign="top"><em>slot</em> </td><td>Callback slot to call when the request is satisfied. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>io_priority</em> </td><td>The io priority of the request. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="c61dbaa1f910c14bf3beaadc0498065f"></a><!-- doxytag: member="Gio::OutputStream::write_finish" ref="c61dbaa1f910c14bf3beaadc0498065f" args="(const Glib::RefPtr< AsyncResult > &result)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gssize Gio::OutputStream::write_finish </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1AsyncResult.html">AsyncResult</a>>& </td>
<td class="paramname"> <em>result</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Finishes a stream write operation.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>result</em> </td><td>A <a class="el" href="classGio_1_1AsyncResult.html" title="Provides a base class for implementing asynchronous function results.">AsyncResult</a>. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A gssize containing the number of bytes written to the stream. </dd></dl>
</div>
</div><p>
<a class="anchor" name="4bfe08685268b2236362bce84ba1cc77"></a><!-- doxytag: member="Gio::OutputStream::splice_async" ref="4bfe08685268b2236362bce84ba1cc77" args="(const Glib::RefPtr< InputStream > &source, const SlotAsyncReady &slot, const Glib::RefPtr< Cancellable > &cancellable, OutputStreamSpliceFlags flags=OUTPUT_STREAM_SPLICE_NONE, int io_priority=Glib::PRIORITY_DEFAULT)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gio::OutputStream::splice_async </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1InputStream.html">InputStream</a>>& </td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespaceGio.html#ecaa02709f9ab83fa2b36d2571665cbe">SlotAsyncReady</a>& </td>
<td class="paramname"> <em>slot</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& </td>
<td class="paramname"> <em>cancellable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__giommEnums.html#g7c30d67e5f60d33fdcd3053123feea74">OutputStreamSpliceFlags</a> </td>
<td class="paramname"> <em>flags</em> = <code>OUTPUT_STREAM_SPLICE_NONE</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>io_priority</em> = <code>Glib::PRIORITY_DEFAULT</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Splices a stream asynchronously.
<p>
When the operation is finished <em>slot</em> will be called. You can then call <a class="el" href="classGio_1_1OutputStream.html#29461238b7b3cf9c2d6dde85b4a6a6ea" title="Finishes an asynchronous stream splice operation.">splice_finish()</a> to get the result of the operation.<p>
For the synchronous, blocking version of this function, see <a class="el" href="classGio_1_1OutputStream.html#080bff3f1f2017b4d4ff8343a5bfbf15" title="Splices an input stream into an output stream.">splice()</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>An <a class="el" href="classGio_1_1InputStream.html" title="Base class for implementing streaming input.">InputStream</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>slot</em> </td><td>Callback slot to call when the request is satisfied. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cancellable</em> </td><td><a class="el" href="classGio_1_1Cancellable.html" title="Allows actions to be cancelled.">Cancellable</a> object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>io_priority</em> </td><td>The io priority of the request. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="85e95838d577180e11831b0f149e8f5c"></a><!-- doxytag: member="Gio::OutputStream::splice_async" ref="85e95838d577180e11831b0f149e8f5c" args="(const Glib::RefPtr< InputStream > &source, const SlotAsyncReady &slot, OutputStreamSpliceFlags flags=OUTPUT_STREAM_SPLICE_NONE, int io_priority=Glib::PRIORITY_DEFAULT)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gio::OutputStream::splice_async </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1InputStream.html">InputStream</a>>& </td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespaceGio.html#ecaa02709f9ab83fa2b36d2571665cbe">SlotAsyncReady</a>& </td>
<td class="paramname"> <em>slot</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__giommEnums.html#g7c30d67e5f60d33fdcd3053123feea74">OutputStreamSpliceFlags</a> </td>
<td class="paramname"> <em>flags</em> = <code>OUTPUT_STREAM_SPLICE_NONE</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>io_priority</em> = <code>Glib::PRIORITY_DEFAULT</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Splices a stream asynchronously.
<p>
When the operation is finished <em>slot</em> will be called. You can then call <a class="el" href="classGio_1_1OutputStream.html#29461238b7b3cf9c2d6dde85b4a6a6ea" title="Finishes an asynchronous stream splice operation.">splice_finish()</a> to get the result of the operation.<p>
For the synchronous, blocking version of this function, see <a class="el" href="classGio_1_1OutputStream.html#080bff3f1f2017b4d4ff8343a5bfbf15" title="Splices an input stream into an output stream.">splice()</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>An <a class="el" href="classGio_1_1InputStream.html" title="Base class for implementing streaming input.">InputStream</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>slot</em> </td><td>Callback slot to call when the request is satisfied. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>io_priority</em> </td><td>The io priority of the request. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="29461238b7b3cf9c2d6dde85b4a6a6ea"></a><!-- doxytag: member="Gio::OutputStream::splice_finish" ref="29461238b7b3cf9c2d6dde85b4a6a6ea" args="(const Glib::RefPtr< AsyncResult > &result)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gssize Gio::OutputStream::splice_finish </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1AsyncResult.html">AsyncResult</a>>& </td>
<td class="paramname"> <em>result</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Finishes an asynchronous stream splice operation.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>result</em> </td><td>A <a class="el" href="classGio_1_1AsyncResult.html" title="Provides a base class for implementing asynchronous function results.">AsyncResult</a>. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A gssize of the number of bytes spliced. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c76478281be9559cb0a924bcc4ead263"></a><!-- doxytag: member="Gio::OutputStream::flush_async" ref="c76478281be9559cb0a924bcc4ead263" args="(const SlotAsyncReady &slot, const Glib::RefPtr< Cancellable > &cancellable, int io_priority=Glib::PRIORITY_DEFAULT)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gio::OutputStream::flush_async </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespaceGio.html#ecaa02709f9ab83fa2b36d2571665cbe">SlotAsyncReady</a>& </td>
<td class="paramname"> <em>slot</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& </td>
<td class="paramname"> <em>cancellable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>io_priority</em> = <code>Glib::PRIORITY_DEFAULT</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Flushes a stream asynchronously.
<p>
When the operation is finished the <em>slot</em> will be called, giving the results. You can then call <a class="el" href="classGio_1_1OutputStream.html#f2e8a3c48152c2fdc744a50016911a3a" title="Finishes flushing an output stream.">flush_finish()</a> to get the result of the operation. For behaviour details see <a class="el" href="classGio_1_1OutputStream.html#6bb81a11ef79dc8ffa9f5a275d2d6e0c" title="Flushed any outstanding buffers in the stream.">flush()</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>slot</em> </td><td>Callback slot to call when the request is satisfied. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cancellable</em> </td><td><a class="el" href="classGio_1_1Cancellable.html" title="Allows actions to be cancelled.">Cancellable</a> object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>io_priority</em> </td><td>The io priority of the request. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a82f241b6c72fef632eaf51b279b25ce"></a><!-- doxytag: member="Gio::OutputStream::flush_async" ref="a82f241b6c72fef632eaf51b279b25ce" args="(const SlotAsyncReady &slot, int io_priority=Glib::PRIORITY_DEFAULT)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gio::OutputStream::flush_async </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespaceGio.html#ecaa02709f9ab83fa2b36d2571665cbe">SlotAsyncReady</a>& </td>
<td class="paramname"> <em>slot</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>io_priority</em> = <code>Glib::PRIORITY_DEFAULT</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Flushes a stream asynchronously.
<p>
When the operation is finished the <em>slot</em> will be called, giving the results. You can then call <a class="el" href="classGio_1_1OutputStream.html#f2e8a3c48152c2fdc744a50016911a3a" title="Finishes flushing an output stream.">flush_finish()</a> to get the result of the operation. For behaviour details see <a class="el" href="classGio_1_1OutputStream.html#6bb81a11ef79dc8ffa9f5a275d2d6e0c" title="Flushed any outstanding buffers in the stream.">flush()</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>slot</em> </td><td>Callback slot to call when the request is satisfied. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>io_priority</em> </td><td>The io priority of the request. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="f2e8a3c48152c2fdc744a50016911a3a"></a><!-- doxytag: member="Gio::OutputStream::flush_finish" ref="f2e8a3c48152c2fdc744a50016911a3a" args="(const Glib::RefPtr< AsyncResult > &result)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gio::OutputStream::flush_finish </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1AsyncResult.html">AsyncResult</a>>& </td>
<td class="paramname"> <em>result</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Finishes flushing an output stream.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>result</em> </td><td>A GAsyncResult. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if flush operation suceeded, <code>false</code> otherwise. </dd></dl>
</div>
</div><p>
<a class="anchor" name="47fb0dbd7f88c9167dacd577dcd8c6c7"></a><!-- doxytag: member="Gio::OutputStream::close_async" ref="47fb0dbd7f88c9167dacd577dcd8c6c7" args="(const SlotAsyncReady &slot, const Glib::RefPtr< Cancellable > &cancellable, int io_priority=Glib::PRIORITY_DEFAULT)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gio::OutputStream::close_async </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespaceGio.html#ecaa02709f9ab83fa2b36d2571665cbe">SlotAsyncReady</a>& </td>
<td class="paramname"> <em>slot</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Cancellable.html">Cancellable</a>>& </td>
<td class="paramname"> <em>cancellable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>io_priority</em> = <code>Glib::PRIORITY_DEFAULT</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Requests an asynchronous close of the stream, releasing resources related to it.
<p>
When the operation is finished the <em>slot</em> will be called, giving the results. You can then call <a class="el" href="classGio_1_1OutputStream.html#8db5ee9e7a3a0c091eeebe960550e6f5" title="Closes an output stream.">close_finish()</a> to get the result of the operation. For behaviour details see <a class="el" href="classGio_1_1OutputStream.html#c3e92678425dd530b22eaab97852ca23" title="Closes the stream, releasing resources related to it.">close()</a>.<p>
The asyncronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one you must override all.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>slot</em> </td><td>Callback slot to call when the request is satisfied. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cancellable</em> </td><td><a class="el" href="classGio_1_1Cancellable.html" title="Allows actions to be cancelled.">Cancellable</a> object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>io_priority</em> </td><td>The io priority of the request. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="92f6a9cc67bfa6a2356a031fb3f691c0"></a><!-- doxytag: member="Gio::OutputStream::close_async" ref="92f6a9cc67bfa6a2356a031fb3f691c0" args="(const SlotAsyncReady &slot, int io_priority=Glib::PRIORITY_DEFAULT)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gio::OutputStream::close_async </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespaceGio.html#ecaa02709f9ab83fa2b36d2571665cbe">SlotAsyncReady</a>& </td>
<td class="paramname"> <em>slot</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>io_priority</em> = <code>Glib::PRIORITY_DEFAULT</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Requests an asynchronous close of the stream, releasing resources related to it.
<p>
When the operation is finished the <em>slot</em> will be called, giving the results. You can then call <a class="el" href="classGio_1_1OutputStream.html#8db5ee9e7a3a0c091eeebe960550e6f5" title="Closes an output stream.">close_finish()</a> to get the result of the operation. For behaviour details see <a class="el" href="classGio_1_1OutputStream.html#c3e92678425dd530b22eaab97852ca23" title="Closes the stream, releasing resources related to it.">close()</a>.<p>
The asyncronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one you must override all.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>slot</em> </td><td>Callback slot to call when the request is satisfied. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>io_priority</em> </td><td>The io priority of the request. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="8db5ee9e7a3a0c091eeebe960550e6f5"></a><!-- doxytag: member="Gio::OutputStream::close_finish" ref="8db5ee9e7a3a0c091eeebe960550e6f5" args="(const Glib::RefPtr< AsyncResult > &result)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gio::OutputStream::close_finish </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1AsyncResult.html">AsyncResult</a>>& </td>
<td class="paramname"> <em>result</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Closes an output stream.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>result</em> </td><td>A <a class="el" href="classGio_1_1AsyncResult.html" title="Provides a base class for implementing asynchronous function results.">AsyncResult</a>. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if stream was successfully closed, <code>false</code> otherwise. </dd></dl>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="96aad4c49fb938a88b75abe5339bef4f"></a><!-- doxytag: member="Gio::OutputStream::wrap" ref="96aad4c49fb938a88b75abe5339bef4f" args="(GOutputStream *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1OutputStream.html">Gio::OutputStream</a>> wrap </td>
<td>(</td>
<td class="paramtype">GOutputStream * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_copy</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A <a class="el" href="namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>take_copy</em> </td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="outputstream_8h.html">outputstream.h</a></ul>
</div> <!-- end main content -->
<hr><address><small>
Generated for glibmm 2.4 by <a href="http://www.doxygen.org/index.html">
Doxygen</a> 1.5.3 © 1997-2001</small></address>
</body>
</html>
