3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>buffer_copy (28 of 30 overloads)</title>
5 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
8 <link rel="up" href="../buffer_copy.html" title="buffer_copy">
9 <link rel="prev" href="overload27.html" title="buffer_copy (27 of 30 overloads)">
10 <link rel="next" href="overload29.html" title="buffer_copy (29 of 30 overloads)">
12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13 <table cellpadding="2" width="100%"><tr>
14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
15 <td align="center"><a href="../../../../../index.html">Home</a></td>
16 <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19 <td align="center"><a href="../../../../../more/index.htm">More</a></td>
22 <div class="spirit-nav">
23 <a accesskey="p" href="overload27.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../buffer_copy.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload29.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
26 <div class="titlepage"><div><div><h4 class="title">
27 <a name="boost_asio.reference.buffer_copy.overload28"></a><a class="link" href="overload28.html" title="buffer_copy (28 of 30 overloads)">buffer_copy
28 (28 of 30 overloads)</a>
29 </h4></div></div></div>
31 Copies a limited number of bytes from a source buffer to a target buffer
34 <pre class="programlisting"><span class="keyword">template</span><span class="special"><</span>
35 <span class="keyword">typename</span> <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">></span>
36 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">buffer_copy</span><span class="special">(</span>
37 <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span> <span class="identifier">target</span><span class="special">,</span>
38 <span class="keyword">const</span> <span class="identifier">mutable_buffer</span> <span class="special">&</span> <span class="identifier">source</span><span class="special">,</span>
39 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">max_bytes_to_copy</span><span class="special">);</span>
42 <a name="boost_asio.reference.buffer_copy.overload28.h0"></a>
43 <span class="phrase"><a name="boost_asio.reference.buffer_copy.overload28.parameters"></a></span><a class="link" href="overload28.html#boost_asio.reference.buffer_copy.overload28.parameters">Parameters</a>
45 <div class="variablelist">
46 <p class="title"><b></b></p>
47 <dl class="variablelist">
48 <dt><span class="term">target</span></dt>
50 A modifiable buffer sequence representing the memory regions to which
51 the bytes will be copied.
53 <dt><span class="term">source</span></dt>
55 A modifiable buffer representing the memory region from which the
56 bytes will be copied. The contents of the source buffer will not
59 <dt><span class="term">max_bytes_to_copy</span></dt>
61 The maximum number of bytes to be copied.
66 <a name="boost_asio.reference.buffer_copy.overload28.h1"></a>
67 <span class="phrase"><a name="boost_asio.reference.buffer_copy.overload28.return_value"></a></span><a class="link" href="overload28.html#boost_asio.reference.buffer_copy.overload28.return_value">Return
71 The number of bytes copied.
74 <a name="boost_asio.reference.buffer_copy.overload28.h2"></a>
75 <span class="phrase"><a name="boost_asio.reference.buffer_copy.overload28.remarks"></a></span><a class="link" href="overload28.html#boost_asio.reference.buffer_copy.overload28.remarks">Remarks</a>
78 The number of bytes copied is the lesser of:
80 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
82 <code class="computeroutput"><span class="identifier">buffer_size</span><span class="special">(</span><span class="identifier">target</span><span class="special">)</span></code>
85 <code class="computeroutput"><span class="identifier">buffer_size</span><span class="special">(</span><span class="identifier">source</span><span class="special">)</span></code>
88 <code class="computeroutput"><span class="identifier">max_bytes_to_copy</span></code>
92 This function is implemented in terms of <code class="computeroutput"><span class="identifier">memcpy</span></code>,
93 and consequently it cannot be used to copy between overlapping memory regions.
96 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
97 <td align="left"></td>
98 <td align="right"><div class="copyright-footer">Copyright © 2003-2014 Christopher M. Kohlhoff<p>
99 Distributed under the Boost Software License, Version 1.0. (See accompanying
100 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
105 <div class="spirit-nav">
106 <a accesskey="p" href="overload27.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../buffer_copy.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload29.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>