doc/html/boost_asio/reference/buffer_copy/overload10.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>buffer_copy (10 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.79.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="overload9.html" title="buffer_copy (9 of 30 overloads)">
  10 <link rel="next" href="overload11.html" title="buffer_copy (11 of 30 overloads)">
  11 </head>
  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>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="overload9.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="overload11.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="boost_asio.reference.buffer_copy.overload10"></a><a class="link" href="overload10.html" title="buffer_copy (10 of 30 overloads)">buffer_copy
  28         (10 of 30 overloads)</a>
  29 </h4></div></div></div>
  30 <p>
  31           Copies bytes from a source buffer sequence to a target buffer.
  32         </p>
  33 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  34     <span class="keyword">typename</span> <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a><span class="special">&gt;</span>
  35 <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>
  36     <span class="keyword">const</span> <span class="identifier">mutable_buffers_1</span> <span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span>
  37     <span class="keyword">const</span> <span class="identifier">ConstBufferSequence</span> <span class="special">&amp;</span> <span class="identifier">source</span><span class="special">);</span>
  38 </pre>
  39 <h6>
  40 <a name="boost_asio.reference.buffer_copy.overload10.h0"></a>
  41           <span class="phrase"><a name="boost_asio.reference.buffer_copy.overload10.parameters"></a></span><a class="link" href="overload10.html#boost_asio.reference.buffer_copy.overload10.parameters">Parameters</a>
  42         </h6>
  43 <div class="variablelist">
  44 <p class="title"><b></b></p>
  45 <dl class="variablelist">
  46 <dt><span class="term">target</span></dt>
  47 <dd><p>
  48                 A modifiable buffer representing the memory region to which the bytes
  49                 will be copied.
  50               </p></dd>
  51 <dt><span class="term">source</span></dt>
  52 <dd><p>
  53                 A non-modifiable buffer sequence representing the memory regions
  54                 from which the bytes will be copied.
  55               </p></dd>
  56 </dl>
  57 </div>
  58 <h6>
  59 <a name="boost_asio.reference.buffer_copy.overload10.h1"></a>
  60           <span class="phrase"><a name="boost_asio.reference.buffer_copy.overload10.return_value"></a></span><a class="link" href="overload10.html#boost_asio.reference.buffer_copy.overload10.return_value">Return
  61           Value</a>
  62         </h6>
  63 <p>
  64           The number of bytes copied.
  65         </p>
  66 <h6>
  67 <a name="boost_asio.reference.buffer_copy.overload10.h2"></a>
  68           <span class="phrase"><a name="boost_asio.reference.buffer_copy.overload10.remarks"></a></span><a class="link" href="overload10.html#boost_asio.reference.buffer_copy.overload10.remarks">Remarks</a>
  69         </h6>
  70 <p>
  71           The number of bytes copied is the lesser of:
  72         </p>
  73 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  74 <li class="listitem">
  75               <code class="computeroutput"><span class="identifier">buffer_size</span><span class="special">(</span><span class="identifier">target</span><span class="special">)</span></code>
  76             </li>
  77 <li class="listitem">
  78               <code class="computeroutput"><span class="identifier">buffer_size</span><span class="special">(</span><span class="identifier">source</span><span class="special">)</span></code>
  79             </li>
  80 </ul></div>
  81 <p>
  82           This function is implemented in terms of <code class="computeroutput"><span class="identifier">memcpy</span></code>,
  83           and consequently it cannot be used to copy between overlapping memory regions.
  84         </p>
  85 </div>
  86 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  87 <td align="left"></td>
  88 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
  89         Distributed under the Boost Software License, Version 1.0. (See accompanying
  90         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>)
  91       </p>
  92 </div></td>
  93 </tr></table>
  94 <hr>
  95 <div class="spirit-nav">
  96 <a accesskey="p" href="overload9.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="overload11.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  97 </div>
  98 </body>
  99 </html>