doc/html/boost_asio/reference/windows__basic_random_access_handle/read_some_at/overload1.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 (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.78.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)">
  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_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>
  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.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>
  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 </pre>
  39 <p>
  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.
  43           </p>
  44 <h6>
  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>
  47           </h6>
  48 <div class="variablelist">
  49 <p class="title"><b></b></p>
  50 <dl class="variablelist">
  51 <dt><span class="term">offset</span></dt>
  52 <dd><p>
  53                   The offset at which the data will be read.
  54                 </p></dd>
  55 <dt><span class="term">buffers</span></dt>
  56 <dd><p>
  57                   One or more buffers into which the data will be read.
  58                 </p></dd>
  59 </dl>
  60 </div>
  61 <h6>
  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
  64             Value</a>
  65           </h6>
  66 <p>
  67             The number of bytes read.
  68           </p>
  69 <h6>
  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>
  72           </h6>
  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>
  77 <dd><p>
  78                   Thrown on failure. An error code of <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">eof</span></code>
  79                   indicates that the connection was closed by the peer.
  80                 </p></dd>
  81 </dl>
  82 </div>
  83 <h6>
  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>
  86           </h6>
  87 <p>
  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"><span class="identifier">read_at</span></code></a> function if you need
  90             to ensure that the requested amount of data is read before the blocking
  91             operation completes.
  92           </p>
  93 <h6>
  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>
  96           </h6>
  97 <p>
  98             To read into a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a> function as follows:
  99           </p>
 100 <pre class="programlisting"><span class="identifier">handle</span><span class="special">.</span><span class="identifier">read_some_at</span><span class="special">(</span><span class="number">42</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">data</span><span class="special">,</span> <span class="identifier">size</span><span class="special">));</span>
 101 </pre>
 102 <p>
 103             See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a>
 104             documentation for information on reading into multiple buffers in one
 105             go, and how to use it with arrays, boost::array or std::vector.
 106           </p>
 107 </div>
 108 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 109 <td align="left"></td>
 110 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
 111         Distributed under the Boost Software License, Version 1.0. (See accompanying
 112         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>)
 113       </p>
 114 </div></td>
 115 </tr></table>
 116 <hr>
 117 <div class="spirit-nav">
 118 <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>
 119 </div>
 120 </body>
 121 </html>