1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.01 Transitional//EN">
4 <TITLE>Function Template copy
</TITLE>
5 <LINK REL=
"stylesheet" HREF=
"../../../../boost.css">
6 <LINK REL=
"stylesheet" HREF=
"../theme/iostreams.css">
12 <H1 CLASS=
"title">Function Template
<CODE>copy
</CODE></H1>
17 <DL class=
"page-index">
18 <DT><A href=
"#description">Description
</A></DT>
19 <DT><A href=
"#headers">Headers
</A></DT>
20 <DT><A href=
"#synopsis">Synopsis
</A></DT>
23 <A NAME=
"description"></A>
26 <P>The function template
<CODE>copy
</CODE> reads data from a given model of
<A HREF=
"../concepts/source.html">Source
</A> and writes it to a given model of
<A HREF=
"../concepts/sink.html">Sink
</A> until the end of stream is reached. It then closes both components, using the function template
<A HREF=
"close.html"><CODE>close
</CODE></A>, and returns the number of characters written.
</P>
28 <P>The size of the temporary buffer used may be supplied as an optional parameter.
</P>
30 <P>There are four overloads of
<CODE>copy
</CODE> to accommodate all combinations of
<A HREF=
"../concepts/source.html">Sources
</A> and
<A HREF=
"../concepts/sink.html">Sinks
</A>, which are passed by
<CODE>const
</CODE> reference, and streams and stream buffers, which are passed by non-
<CODE>const
</CODE> reference.
</P>
32 <A NAME=
"headers"></A>
36 <DT><A CLASS=
"header" HREF=
"../../../../boost/iostreams/copy.hpp"><CODE><boost/iostreams/copy.hpp
></CODE></A></DT>
39 <A NAME=
"synopsis"></A>
42 <PRE CLASS=
"broken_ie"><SPAN CLASS=
"keyword">namespace
</SPAN> boost {
<SPAN CLASS=
"keyword">namespace
</SPAN> iostreams {
44 <SPAN CLASS=
"keyword">template
</SPAN><<SPAN CLASS=
"keyword">typename
</SPAN> Source,
<SPAN CLASS=
"keyword">typename
</SPAN> Sink
>
46 copy( [
<SPAN CLASS=
"keyword">const
</SPAN>] Source
& src, [
<SPAN CLASS=
"keyword">const
</SPAN>] Sink
& sink,
47 std::streamsize buffer_size =
<SPAN CLASS=
"omitted">default value
</SPAN> );
49 } }
<SPAN CLASS=
"comment">// End namespace boost::io
</SPAN></PRE>
56 <P CLASS=
"copyright">© Copyright
2008 <a href=
"http://www.coderage.com/" target=
"_top">CodeRage, LLC
</a><br/>© Copyright
2004-
2007 <a href=
"http://www.coderage.com/turkanis/" target=
"_top">Jonathan Turkanis
</a></P>
58 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>)