Files
iostreams/doc/guide/convenience.html
Jonathan Turkanis 9b39e2a437 major documentation upgrade, phase II
[SVN r29504]
2005-06-10 04:03:05 +00:00

66 lines
1.9 KiB
HTML
Executable File

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML>
<HEAD>
<TITLE>Convenience Functions</TITLE>
<LINK REL="stylesheet" HREF="../../../../boost.css">
<LINK REL="stylesheet" HREF="../theme/iostreams.css">
</HEAD>
<BODY>
<!-- Begin Banner -->
<H1 CLASS="title">Convenience Functions</H1>
<HR CLASS="banner">
<!-- End Banner -->
<DL class="page-index">
<DT><A href="#overview">Overview</A></DT>
<DT><A href="#headers">Headers</A></DT>
<DT><A href="#reference">Reference</A></DT>
</DL>
<A NAME="overview">
<H2>Overview</H2>
<P>
The Boost Iostreams library contains the convenience function <A HREF="../functions/copy.html"><CODE>copy</CODE></A> which reads data from a provided source and writes it to a provided sink, until the end of stream is reached. It is a more flexible version of the <CODE>std::basic_ostream</CODE> member function
<PRE CLASS="broken_ie">basic_ostream&lt;Ch, Tr&gt;& operator&lt;&lt;(basic_streambuf&lt;Ch, Tr&gt;*);</PRE>
</P>
<P>
More convenience functions may be added in the future.
</P>
<A NAME="headers">
<H2>Headers</H2>
<DL>
<DT><A CLASS="header" HREF="../../../../boost/iostreams/copy.hpp"><CODE>&lt;boost/iostreams/copy.hpp&gt;</CODE></A></DT>
</DL>
<A NAME="reference">
<H2>Reference</H2>
<DL>
<DT><A HREF="../functions/copy.html">Function template <CODE>copy</CODE></A></DT>
</DL>
<!-- Begin Footer -->
<HR>
<P CLASS="copyright">Revised
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
20 May, 2004
<!--webbot bot="Timestamp" endspan i-checksum="38504" -->
</P>
<P CLASS="copyright">&copy; Copyright Jonathan Turkanis, 2004</P>
<P CLASS="copyright">
Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at <A HREF="http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</A>)
</P>
<!-- End Footer -->
</BODY>