1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>read_at (5 of 8 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_at.html" title="read_at"> 9<link rel="prev" href="overload4.html" title="read_at (4 of 8 overloads)"> 10<link rel="next" href="overload6.html" title="read_at (6 of 8 overloads)"> 11</head> 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> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="overload4.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_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="overload6.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h4 class="title"> 27<a name="boost_asio.reference.read_at.overload5"></a><a class="link" href="overload5.html" title="read_at (5 of 8 overloads)">read_at (5 28 of 8 overloads)</a> 29</h4></div></div></div> 30<p> 31 Attempt to read a certain amount of data at the specified offset before 32 returning. 33 </p> 34<pre class="programlisting">template< 35 typename <a class="link" href="../SyncRandomAccessReadDevice.html" title="Buffer-oriented synchronous random-access read device requirements">SyncRandomAccessReadDevice</a>, 36 typename Allocator> 37std::size_t read_at( 38 SyncRandomAccessReadDevice & d, 39 uint64_t offset, 40 basic_streambuf< Allocator > & b); 41</pre> 42<p> 43 This function is used to read a certain number of bytes of data from a 44 random access device at the specified offset. The call will block until 45 one of the following conditions is true: 46 </p> 47<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> 48 An error occurred. 49 </li></ul></div> 50<p> 51 This operation is implemented in terms of zero or more calls to the device's 52 read_some_at function. 53 </p> 54<h6> 55<a name="boost_asio.reference.read_at.overload5.h0"></a> 56 <span class="phrase"><a name="boost_asio.reference.read_at.overload5.parameters"></a></span><a class="link" href="overload5.html#boost_asio.reference.read_at.overload5.parameters">Parameters</a> 57 </h6> 58<div class="variablelist"> 59<p class="title"><b></b></p> 60<dl class="variablelist"> 61<dt><span class="term">d</span></dt> 62<dd><p> 63 The device from which the data is to be read. The type must support 64 the SyncRandomAccessReadDevice concept. 65 </p></dd> 66<dt><span class="term">offset</span></dt> 67<dd><p> 68 The offset at which the data will be read. 69 </p></dd> 70<dt><span class="term">b</span></dt> 71<dd><p> 72 The <a class="link" href="../basic_streambuf.html" title="basic_streambuf"><code class="computeroutput">basic_streambuf</code></a> 73 object into which the data will be read. 74 </p></dd> 75</dl> 76</div> 77<h6> 78<a name="boost_asio.reference.read_at.overload5.h1"></a> 79 <span class="phrase"><a name="boost_asio.reference.read_at.overload5.return_value"></a></span><a class="link" href="overload5.html#boost_asio.reference.read_at.overload5.return_value">Return Value</a> 80 </h6> 81<p> 82 The number of bytes transferred. 83 </p> 84<h6> 85<a name="boost_asio.reference.read_at.overload5.h2"></a> 86 <span class="phrase"><a name="boost_asio.reference.read_at.overload5.exceptions"></a></span><a class="link" href="overload5.html#boost_asio.reference.read_at.overload5.exceptions">Exceptions</a> 87 </h6> 88<div class="variablelist"> 89<p class="title"><b></b></p> 90<dl class="variablelist"> 91<dt><span class="term">boost::system::system_error</span></dt> 92<dd><p> 93 Thrown on failure. 94 </p></dd> 95</dl> 96</div> 97<h6> 98<a name="boost_asio.reference.read_at.overload5.h3"></a> 99 <span class="phrase"><a name="boost_asio.reference.read_at.overload5.remarks"></a></span><a class="link" href="overload5.html#boost_asio.reference.read_at.overload5.remarks">Remarks</a> 100 </h6> 101<p> 102 This overload is equivalent to calling: 103 </p> 104<pre class="programlisting">boost::asio::read_at( 105 d, 42, b, 106 boost::asio::transfer_all()); 107</pre> 108</div> 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-2020 Christopher M. 112 Kohlhoff<p> 113 Distributed under the Boost Software License, Version 1.0. (See accompanying 114 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>) 115 </p> 116</div></td> 117</tr></table> 118<hr> 119<div class="spirit-nav"> 120<a accesskey="p" href="overload4.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_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="overload6.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 121</div> 122</body> 123</html> 124
