doc/html/boost_asio/reference/read_at.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>read_at</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="../reference.html" title="Reference">
   9 <link rel="prev" href="read/overload8.html" title="read (8 of 8 overloads)">
  10 <link rel="next" href="read_at/overload1.html" title="read_at (1 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="read/overload8.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="read_at/overload1.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h3 class="title">
  27 <a name="boost_asio.reference.read_at"></a><a class="link" href="read_at.html" title="read_at">read_at</a>
  28 </h3></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idp161589632"></a>
  31 Attempt to read a certain amount of data at the specified offset before
  32         returning.
  33       </p>
  34 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  35     <span class="keyword">typename</span> <a class="link" href="SyncRandomAccessReadDevice.html" title="Buffer-oriented synchronous random-access read device requirements">SyncRandomAccessReadDevice</a><span class="special">,</span>
  36     <span class="keyword">typename</span> <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">&gt;</span>
  37 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read_at/overload1.html" title="read_at (1 of 8 overloads)">read_at</a><span class="special">(</span>
  38     <span class="identifier">SyncRandomAccessReadDevice</span> <span class="special">&amp;</span> <span class="identifier">d</span><span class="special">,</span>
  39     <span class="identifier">uint64_t</span> <span class="identifier">offset</span><span class="special">,</span>
  40     <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">);</span>
  41   <span class="emphasis"><em>&#187; <a class="link" href="read_at/overload1.html" title="read_at (1 of 8 overloads)">more...</a></em></span>
  42
  43 <span class="keyword">template</span><span class="special">&lt;</span>
  44     <span class="keyword">typename</span> <a class="link" href="SyncRandomAccessReadDevice.html" title="Buffer-oriented synchronous random-access read device requirements">SyncRandomAccessReadDevice</a><span class="special">,</span>
  45     <span class="keyword">typename</span> <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">&gt;</span>
  46 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read_at/overload2.html" title="read_at (2 of 8 overloads)">read_at</a><span class="special">(</span>
  47     <span class="identifier">SyncRandomAccessReadDevice</span> <span class="special">&amp;</span> <span class="identifier">d</span><span class="special">,</span>
  48     <span class="identifier">uint64_t</span> <span class="identifier">offset</span><span class="special">,</span>
  49     <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">,</span>
  50     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
  51   <span class="emphasis"><em>&#187; <a class="link" href="read_at/overload2.html" title="read_at (2 of 8 overloads)">more...</a></em></span>
  52
  53 <span class="keyword">template</span><span class="special">&lt;</span>
  54     <span class="keyword">typename</span> <a class="link" href="SyncRandomAccessReadDevice.html" title="Buffer-oriented synchronous random-access read device requirements">SyncRandomAccessReadDevice</a><span class="special">,</span>
  55     <span class="keyword">typename</span> <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">,</span>
  56     <span class="keyword">typename</span> <span class="identifier">CompletionCondition</span><span class="special">&gt;</span>
  57 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read_at/overload3.html" title="read_at (3 of 8 overloads)">read_at</a><span class="special">(</span>
  58     <span class="identifier">SyncRandomAccessReadDevice</span> <span class="special">&amp;</span> <span class="identifier">d</span><span class="special">,</span>
  59     <span class="identifier">uint64_t</span> <span class="identifier">offset</span><span class="special">,</span>
  60     <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">,</span>
  61     <span class="identifier">CompletionCondition</span> <span class="identifier">completion_condition</span><span class="special">);</span>
  62   <span class="emphasis"><em>&#187; <a class="link" href="read_at/overload3.html" title="read_at (3 of 8 overloads)">more...</a></em></span>
  63
  64 <span class="keyword">template</span><span class="special">&lt;</span>
  65     <span class="keyword">typename</span> <a class="link" href="SyncRandomAccessReadDevice.html" title="Buffer-oriented synchronous random-access read device requirements">SyncRandomAccessReadDevice</a><span class="special">,</span>
  66     <span class="keyword">typename</span> <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">,</span>
  67     <span class="keyword">typename</span> <span class="identifier">CompletionCondition</span><span class="special">&gt;</span>
  68 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read_at/overload4.html" title="read_at (4 of 8 overloads)">read_at</a><span class="special">(</span>
  69     <span class="identifier">SyncRandomAccessReadDevice</span> <span class="special">&amp;</span> <span class="identifier">d</span><span class="special">,</span>
  70     <span class="identifier">uint64_t</span> <span class="identifier">offset</span><span class="special">,</span>
  71     <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">,</span>
  72     <span class="identifier">CompletionCondition</span> <span class="identifier">completion_condition</span><span class="special">,</span>
  73     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
  74   <span class="emphasis"><em>&#187; <a class="link" href="read_at/overload4.html" title="read_at (4 of 8 overloads)">more...</a></em></span>
  75
  76 <span class="keyword">template</span><span class="special">&lt;</span>
  77     <span class="keyword">typename</span> <a class="link" href="SyncRandomAccessReadDevice.html" title="Buffer-oriented synchronous random-access read device requirements">SyncRandomAccessReadDevice</a><span class="special">,</span>
  78     <span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">&gt;</span>
  79 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read_at/overload5.html" title="read_at (5 of 8 overloads)">read_at</a><span class="special">(</span>
  80     <span class="identifier">SyncRandomAccessReadDevice</span> <span class="special">&amp;</span> <span class="identifier">d</span><span class="special">,</span>
  81     <span class="identifier">uint64_t</span> <span class="identifier">offset</span><span class="special">,</span>
  82     <span class="identifier">basic_streambuf</span><span class="special">&lt;</span> <span class="identifier">Allocator</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">b</span><span class="special">);</span>
  83   <span class="emphasis"><em>&#187; <a class="link" href="read_at/overload5.html" title="read_at (5 of 8 overloads)">more...</a></em></span>
  84
  85 <span class="keyword">template</span><span class="special">&lt;</span>
  86     <span class="keyword">typename</span> <a class="link" href="SyncRandomAccessReadDevice.html" title="Buffer-oriented synchronous random-access read device requirements">SyncRandomAccessReadDevice</a><span class="special">,</span>
  87     <span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">&gt;</span>
  88 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read_at/overload6.html" title="read_at (6 of 8 overloads)">read_at</a><span class="special">(</span>
  89     <span class="identifier">SyncRandomAccessReadDevice</span> <span class="special">&amp;</span> <span class="identifier">d</span><span class="special">,</span>
  90     <span class="identifier">uint64_t</span> <span class="identifier">offset</span><span class="special">,</span>
  91     <span class="identifier">basic_streambuf</span><span class="special">&lt;</span> <span class="identifier">Allocator</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">b</span><span class="special">,</span>
  92     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
  93   <span class="emphasis"><em>&#187; <a class="link" href="read_at/overload6.html" title="read_at (6 of 8 overloads)">more...</a></em></span>
  94
  95 <span class="keyword">template</span><span class="special">&lt;</span>
  96     <span class="keyword">typename</span> <a class="link" href="SyncRandomAccessReadDevice.html" title="Buffer-oriented synchronous random-access read device requirements">SyncRandomAccessReadDevice</a><span class="special">,</span>
  97     <span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
  98     <span class="keyword">typename</span> <span class="identifier">CompletionCondition</span><span class="special">&gt;</span>
  99 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read_at/overload7.html" title="read_at (7 of 8 overloads)">read_at</a><span class="special">(</span>
 100     <span class="identifier">SyncRandomAccessReadDevice</span> <span class="special">&amp;</span> <span class="identifier">d</span><span class="special">,</span>
 101     <span class="identifier">uint64_t</span> <span class="identifier">offset</span><span class="special">,</span>
 102     <span class="identifier">basic_streambuf</span><span class="special">&lt;</span> <span class="identifier">Allocator</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">b</span><span class="special">,</span>
 103     <span class="identifier">CompletionCondition</span> <span class="identifier">completion_condition</span><span class="special">);</span>
 104   <span class="emphasis"><em>&#187; <a class="link" href="read_at/overload7.html" title="read_at (7 of 8 overloads)">more...</a></em></span>
 105
 106 <span class="keyword">template</span><span class="special">&lt;</span>
 107     <span class="keyword">typename</span> <a class="link" href="SyncRandomAccessReadDevice.html" title="Buffer-oriented synchronous random-access read device requirements">SyncRandomAccessReadDevice</a><span class="special">,</span>
 108     <span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
 109     <span class="keyword">typename</span> <span class="identifier">CompletionCondition</span><span class="special">&gt;</span>
 110 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read_at/overload8.html" title="read_at (8 of 8 overloads)">read_at</a><span class="special">(</span>
 111     <span class="identifier">SyncRandomAccessReadDevice</span> <span class="special">&amp;</span> <span class="identifier">d</span><span class="special">,</span>
 112     <span class="identifier">uint64_t</span> <span class="identifier">offset</span><span class="special">,</span>
 113     <span class="identifier">basic_streambuf</span><span class="special">&lt;</span> <span class="identifier">Allocator</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">b</span><span class="special">,</span>
 114     <span class="identifier">CompletionCondition</span> <span class="identifier">completion_condition</span><span class="special">,</span>
 115     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
 116   <span class="emphasis"><em>&#187; <a class="link" href="read_at/overload8.html" title="read_at (8 of 8 overloads)">more...</a></em></span>
 117 </pre>
 118 <h5>
 119 <a name="boost_asio.reference.read_at.h0"></a>
 120         <span class="phrase"><a name="boost_asio.reference.read_at.requirements"></a></span><a class="link" href="read_at.html#boost_asio.reference.read_at.requirements">Requirements</a>
 121       </h5>
 122 <p>
 123         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/read_at.hpp</code>
 124       </p>
 125 <p>
 126         <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 127       </p>
 128 </div>
 129 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 130 <td align="left"></td>
 131 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
 132         Distributed under the Boost Software License, Version 1.0. (See accompanying
 133         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>)
 134       </p>
 135 </div></td>
 136 </tr></table>
 137 <hr>
 138 <div class="spirit-nav">
 139 <a accesskey="p" href="read/overload8.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="read_at/overload1.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 140 </div>
 141 </body>
 142 </html>