doc/html/boost_asio/reference/buffer_copy/overload25.html

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