overload2.html
4.98 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>buffer_copy (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../buffer_copy.html" title="buffer_copy">
<link rel="prev" href="overload1.html" title="buffer_copy (1 of 2 overloads)">
<link rel="next" href="../buffer_sequence_begin.html" title="buffer_sequence_begin">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../buffer_copy.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="../buffer_sequence_begin.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.buffer_copy.overload2"></a><a class="link" href="overload2.html" title="buffer_copy (2 of 2 overloads)">buffer_copy (2
of 2 overloads)</a>
</h4></div></div></div>
<p>
Copies a limited number of bytes from a source buffer sequence to a target
buffer sequence.
</p>
<pre class="programlisting">template<
typename <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>,
typename <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>>
std::size_t buffer_copy(
const MutableBufferSequence & target,
const ConstBufferSequence & source,
std::size_t max_bytes_to_copy);
</pre>
<h6>
<a name="asio.reference.buffer_copy.overload2.h0"></a>
<span><a name="asio.reference.buffer_copy.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.buffer_copy.overload2.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 sequence representing the memory regions 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="asio.reference.buffer_copy.overload2.h1"></a>
<span><a name="asio.reference.buffer_copy.overload2.return_value"></a></span><a class="link" href="overload2.html#asio.reference.buffer_copy.overload2.return_value">Return
Value</a>
</h6>
<p>
The number of bytes copied.
</p>
<h6>
<a name="asio.reference.buffer_copy.overload2.h2"></a>
<span><a name="asio.reference.buffer_copy.overload2.remarks"></a></span><a class="link" href="overload2.html#asio.reference.buffer_copy.overload2.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">buffer_size(target)</code>
</li>
<li class="listitem">
<code class="computeroutput">buffer_size(source)</code>
</li>
<li class="listitem">
<code class="computeroutput">max_bytes_to_copy</code>
</li>
</ul></div>
<p>
This function is implemented in terms of <code class="computeroutput">memcpy</code>, and consequently
it cannot be used to copy between overlapping memory regions.
</p>
</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-2020 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="overload1.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../buffer_copy.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="../buffer_sequence_begin.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>