diff options
Diffstat (limited to 'doc/html/boost_asio/reference/buffer_copy/overload20.html')
-rwxr-xr-x | doc/html/boost_asio/reference/buffer_copy/overload20.html | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/doc/html/boost_asio/reference/buffer_copy/overload20.html b/doc/html/boost_asio/reference/buffer_copy/overload20.html new file mode 100755 index 0000000000..9261a2a143 --- /dev/null +++ b/doc/html/boost_asio/reference/buffer_copy/overload20.html @@ -0,0 +1,104 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>buffer_copy (20 of 30 overloads)</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../buffer_copy.html" title="buffer_copy"> +<link rel="prev" href="overload19.html" title="buffer_copy (19 of 30 overloads)"> +<link rel="next" href="overload21.html" title="buffer_copy (21 of 30 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload19.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="overload21.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.buffer_copy.overload20"></a><a class="link" href="overload20.html" title="buffer_copy (20 of 30 overloads)">buffer_copy + (20 of 30 overloads)</a> +</h4></div></div></div> +<p> + Copies a limited number of bytes from a source buffer sequence to a target + buffer. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a><span class="special">></span> +<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> + <span class="keyword">const</span> <span class="identifier">mutable_buffer</span> <span class="special">&</span> <span class="identifier">target</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">ConstBufferSequence</span> <span class="special">&</span> <span class="identifier">source</span><span class="special">,</span> + <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> +</pre> +<h6> +<a name="boost_asio.reference.buffer_copy.overload20.h0"></a> + <span><a name="boost_asio.reference.buffer_copy.overload20.parameters"></a></span><a class="link" href="overload20.html#boost_asio.reference.buffer_copy.overload20.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">target</span></dt> +<dd><p> + A modifiable buffer representing the memory region to which the bytes + will be copied. + </p></dd> +<dt><span class="term">source</span></dt> +<dd><p> + A non-modifiable buffer sequence representing the memory regions + from which the bytes will be copied. + </p></dd> +<dt><span class="term">max_bytes_to_copy</span></dt> +<dd><p> + The maximum number of bytes to be copied. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.buffer_copy.overload20.h1"></a> + <span><a name="boost_asio.reference.buffer_copy.overload20.return_value"></a></span><a class="link" href="overload20.html#boost_asio.reference.buffer_copy.overload20.return_value">Return + Value</a> + </h6> +<p> + The number of bytes copied. + </p> +<h6> +<a name="boost_asio.reference.buffer_copy.overload20.h2"></a> + <span><a name="boost_asio.reference.buffer_copy.overload20.remarks"></a></span><a class="link" href="overload20.html#boost_asio.reference.buffer_copy.overload20.remarks">Remarks</a> + </h6> +<p> + The number of bytes copied is the lesser of: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">buffer_size</span><span class="special">(</span><span class="identifier">target</span><span class="special">)</span></code> + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">buffer_size</span><span class="special">(</span><span class="identifier">source</span><span class="special">)</span></code> + </li> +<li class="listitem"> + <code class="computeroutput"><span class="identifier">max_bytes_to_copy</span></code> + </li> +</ul></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + 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" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload19.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="overload21.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |