doc/html/boost_asio/reference/windows__basic_random_access_handle/read_some_at/overload2.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>windows::basic_random_access_handle::read_some_at (2 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="overload1.html" title="windows::basic_random_access_handle::read_some_at (1 of 2 overloads)">
  10 <link rel="next" href="../service.html" title="windows::basic_random_access_handle::service">
  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="overload1.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="../service.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload2"></a><a class="link" href="overload2.html" title="windows::basic_random_access_handle::read_some_at (2 of 2 overloads)">windows::basic_random_access_handle::read_some_at
  28           (2 of 2 overloads)</a>
  29 </h5></div></div></div>
  30 <p>
  31             Read some data from the handle at the specified offset.
  32           </p>
  33 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  34     <span class="keyword">typename</span> <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">&gt;</span>
  35 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">read_some_at</span><span class="special">(</span>
  36     <span class="identifier">uint64_t</span> <span class="identifier">offset</span><span class="special">,</span>
  37     <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">,</span>
  38     <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>
  39 </pre>
  40 <p>
  41             This function is used to read data from the random-access handle. The
  42             function call will block until one or more bytes of data has been read
  43             successfully, or until an error occurs.
  44           </p>
  45 <h6>
  46 <a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload2.h0"></a>
  47             <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload2.parameters">Parameters</a>
  48           </h6>
  49 <div class="variablelist">
  50 <p class="title"><b></b></p>
  51 <dl class="variablelist">
  52 <dt><span class="term">offset</span></dt>
  53 <dd><p>
  54                   The offset at which the data will be read.
  55                 </p></dd>
  56 <dt><span class="term">buffers</span></dt>
  57 <dd><p>
  58                   One or more buffers into which the data will be read.
  59                 </p></dd>
  60 <dt><span class="term">ec</span></dt>
  61 <dd><p>
  62                   Set to indicate what error occurred, if any.
  63                 </p></dd>
  64 </dl>
  65 </div>
  66 <h6>
  67 <a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload2.h1"></a>
  68             <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload2.return_value">Return
  69             Value</a>
  70           </h6>
  71 <p>
  72             The number of bytes read. Returns 0 if an error occurred.
  73           </p>
  74 <h6>
  75 <a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload2.h2"></a>
  76             <span class="phrase"><a name="boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_random_access_handle.read_some_at.overload2.remarks">Remarks</a>
  77           </h6>
  78 <p>
  79             The read_some operation may not read all of the requested number of bytes.
  80             Consider using the <a class="link" href="../../read_at.html" title="read_at"><code class="computeroutput"><span class="identifier">read_at</span></code></a> function if you need
  81             to ensure that the requested amount of data is read before the blocking
  82             operation completes.
  83           </p>
  84 </div>
  85 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  86 <td align="left"></td>
  87 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
  88         Distributed under the Boost Software License, Version 1.0. (See accompanying
  89         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>)
  90       </p>
  91 </div></td>
  92 </tr></table>
  93 <hr>
  94 <div class="spirit-nav">
  95 <a accesskey="p" href="overload1.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="../service.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  96 </div>
  97 </body>
  98 </html>