Insane_DNS/libraries/asio-1.28.1/doc/asio/reference/buffer_copy/overload2.html

101 lines
6.0 KiB
HTML
Raw Normal View History

2023-10-24 21:59:30 -04:00
<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_literals__operator_quot__quot__buf.html" title='buffer_literals::operator""_buf'>
<meta name="viewport" content="width=device-width, initial-scale=1">
</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_literals__operator_quot__quot__buf.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"><span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><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">&gt;</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">MutableBufferSequence</span> <span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">ConstBufferSequence</span> <span class="special">&amp;</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="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"><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>
<p>
This function is implemented in terms of <code class="computeroutput"><span class="identifier">memcpy</span></code>,
and consequently it cannot be used to copy between overlapping memory regions.
</p>
</div>
<div class="copyright-footer">Copyright © 2003-2023 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>
<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_literals__operator_quot__quot__buf.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>