3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>windows::basic_random_access_handle::read_some_at (1 of 2 overloads)</title>
5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7 <link rel="home" href="../../../../boost_asio.html" title="Boost.Asio">
8 <link rel="up" href="../read_some_at.html" title="windows::basic_random_access_handle::read_some_at">
9 <link rel="prev" href="../read_some_at.html" title="windows::basic_random_access_handle::read_some_at">
10 <link rel="next" href="overload2.html" title="windows::basic_random_access_handle::read_some_at (2 of 2 overloads)">
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>
22 <div class="spirit-nav">
23 <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>
26 <div class="titlepage"><div><div><h5 class="title">
27 <a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1"></a><a class="link" href="overload1.html" title="windows::basic_random_access_handle::read_some_at (1 of 2 overloads)">windows::basic_random_access_handle::read_some_at
28 (1 of 2 overloads)</a>
29 </h5></div></div></div>
31 Read some data from the handle at the specified offset.
33 <pre class="programlisting">template<
34 typename <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>>
35 std::size_t read_some_at(
37 const MutableBufferSequence & buffers);
40 This function is used to read data from the random-access handle. The
41 function call will block until one or more bytes of data has been read
42 successfully, or until an error occurs.
45 <a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.h0"></a>
46 <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.parameters">Parameters</a>
48 <div class="variablelist">
49 <p class="title"><b></b></p>
50 <dl class="variablelist">
51 <dt><span class="term">offset</span></dt>
53 The offset at which the data will be read.
55 <dt><span class="term">buffers</span></dt>
57 One or more buffers into which the data will be read.
62 <a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.h1"></a>
63 <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.return_value">Return
67 The number of bytes read.
70 <a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.h2"></a>
71 <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.exceptions">Exceptions</a>
73 <div class="variablelist">
74 <p class="title"><b></b></p>
75 <dl class="variablelist">
76 <dt><span class="term">boost::system::system_error</span></dt>
78 Thrown on failure. An error code of <code class="computeroutput">boost::asio::error::eof</code>
79 indicates that the connection was closed by the peer.
84 <a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.h3"></a>
85 <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.remarks">Remarks</a>
88 The read_some operation may not read all of the requested number of bytes.
89 Consider using the <a class="link" href="../../read_at.html" title="read_at"><code class="computeroutput">read_at</code></a>
90 function if you need to ensure that the requested amount of data is read
91 before the blocking operation completes.
94 <a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.h4"></a>
95 <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload1.example">Example</a>
98 To read into a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
101 <pre class="programlisting">handle.read_some_at(42, boost::asio::buffer(data, size));
104 See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
105 documentation for information on reading into multiple buffers in one
106 go, and how to use it with arrays, boost::array or std::vector.
109 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
110 <td align="left"></td>
111 <td align="right"><div class="copyright-footer">Copyright © 2003-2019 Christopher M. Kohlhoff<p>
112 Distributed under the Boost Software License, Version 1.0. (See accompanying
113 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>)
118 <div class="spirit-nav">
119 <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>