diff options
Diffstat (limited to 'doc/html/boost_asio/reference/windows__random_access_handle/read_some_at/overload1.html')
-rw-r--r-- | doc/html/boost_asio/reference/windows__random_access_handle/read_some_at/overload1.html | 122 |
1 files changed, 0 insertions, 122 deletions
diff --git a/doc/html/boost_asio/reference/windows__random_access_handle/read_some_at/overload1.html b/doc/html/boost_asio/reference/windows__random_access_handle/read_some_at/overload1.html deleted file mode 100644 index 3c47bcb7e6..0000000000 --- a/doc/html/boost_asio/reference/windows__random_access_handle/read_some_at/overload1.html +++ /dev/null @@ -1,122 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>windows::random_access_handle::read_some_at (1 of 2 overloads)</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> -<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> -<link rel="up" href="../read_some_at.html" title="windows::random_access_handle::read_some_at"> -<link rel="prev" href="../read_some_at.html" title="windows::random_access_handle::read_some_at"> -<link rel="next" href="overload2.html" title="windows::random_access_handle::read_some_at (2 of 2 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="../read_some_at.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some_at.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="section"> -<div class="titlepage"><div><div><h5 class="title"> -<a name="boost_asio.reference.windows__random_access_handle.read_some_at.overload1"></a><a class="link" href="overload1.html" title="windows::random_access_handle::read_some_at (1 of 2 overloads)">windows::random_access_handle::read_some_at - (1 of 2 overloads)</a> -</h5></div></div></div> -<p> - Read some data from the handle at the specified offset. - </p> -<pre class="programlisting">template< - typename <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>> -std::size_t read_some_at( - uint64_t offset, - const MutableBufferSequence & buffers); -</pre> -<p> - This function is used to read data from the random-access handle. The - function call will block until one or more bytes of data has been read - successfully, or until an error occurs. - </p> -<h6> -<a name="boost_asio.reference.windows__random_access_handle.read_some_at.overload1.h0"></a> - <span class="phrase"><a name="boost_asio.reference.windows__random_access_handle.read_some_at.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__random_access_handle.read_some_at.overload1.parameters">Parameters</a> - </h6> -<div class="variablelist"> -<p class="title"><b></b></p> -<dl class="variablelist"> -<dt><span class="term">offset</span></dt> -<dd><p> - The offset at which the data will be read. - </p></dd> -<dt><span class="term">buffers</span></dt> -<dd><p> - One or more buffers into which the data will be read. - </p></dd> -</dl> -</div> -<h6> -<a name="boost_asio.reference.windows__random_access_handle.read_some_at.overload1.h1"></a> - <span class="phrase"><a name="boost_asio.reference.windows__random_access_handle.read_some_at.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__random_access_handle.read_some_at.overload1.return_value">Return - Value</a> - </h6> -<p> - The number of bytes read. - </p> -<h6> -<a name="boost_asio.reference.windows__random_access_handle.read_some_at.overload1.h2"></a> - <span class="phrase"><a name="boost_asio.reference.windows__random_access_handle.read_some_at.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__random_access_handle.read_some_at.overload1.exceptions">Exceptions</a> - </h6> -<div class="variablelist"> -<p class="title"><b></b></p> -<dl class="variablelist"> -<dt><span class="term">boost::system::system_error</span></dt> -<dd><p> - Thrown on failure. An error code of <code class="computeroutput">boost::asio::error::eof</code> - indicates that the connection was closed by the peer. - </p></dd> -</dl> -</div> -<h6> -<a name="boost_asio.reference.windows__random_access_handle.read_some_at.overload1.h3"></a> - <span class="phrase"><a name="boost_asio.reference.windows__random_access_handle.read_some_at.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__random_access_handle.read_some_at.overload1.remarks">Remarks</a> - </h6> -<p> - The read_some operation may not read all of the requested number of bytes. - Consider using the <a class="link" href="../../read_at.html" title="read_at"><code class="computeroutput">read_at</code></a> - function if you need to ensure that the requested amount of data is read - before the blocking operation completes. - </p> -<h6> -<a name="boost_asio.reference.windows__random_access_handle.read_some_at.overload1.h4"></a> - <span class="phrase"><a name="boost_asio.reference.windows__random_access_handle.read_some_at.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__random_access_handle.read_some_at.overload1.example">Example</a> - </h6> -<p> - To read into a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a> - function as follows: - </p> -<pre class="programlisting">handle.read_some_at(42, boost::asio::buffer(data, size)); -</pre> -<p> - See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a> - documentation for information on reading into multiple buffers in one - go, and how to use it with arrays, boost::array or std::vector. - </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-2018 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="../read_some_at.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some_at.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> |