Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > 3ff61ef50f7b6da9fdee54352ae073f9 > files > 2631

asio-1.4.8-7.mga5.i586.rpm

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>windows::basic_random_access_handle::read_some_at (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="../../../../index.html" title="Asio">
<link rel="up" href="../read_some_at.html" title="windows::basic_random_access_handle::read_some_at">
<link rel="prev" href="../read_some_at.html" title="windows::basic_random_access_handle::read_some_at">
<link rel="next" href="overload2.html" title="windows::basic_random_access_handle::read_some_at (2 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../read_some_at.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_some_at.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h5 class="title">
<a name="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
          (1 of 2 overloads)</a>
</h5></div></div></div>
<p>
            Read some data from the handle at the specified offset.
          </p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">typename</span> <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">&gt;</span>
<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>
    <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint64_t</span> <span class="identifier">offset</span><span class="special">,</span>
    <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">);</span>
</pre>
<p>
            This function is used to read data from the random-access handle. The
            function call will block until one or more bytes of data has been read
            successfully, or until an error occurs.
          </p>
<a name="asio.reference.windows__basic_random_access_handle.read_some_at.overload1.parameters"></a><h6>
<a name="id1192723"></a>
            <a class="link" href="overload1.html#asio.reference.windows__basic_random_access_handle.read_some_at.overload1.parameters">Parameters</a>
          </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">offset</span></dt>
<dd><p>
                  The offset at which the data will be read.
                </p></dd>
<dt><span class="term">buffers</span></dt>
<dd><p>
                  One or more buffers into which the data will be read.
                </p></dd>
</dl>
</div>
<a name="asio.reference.windows__basic_random_access_handle.read_some_at.overload1.return_value"></a><h6>
<a name="id1192777"></a>
            <a class="link" href="overload1.html#asio.reference.windows__basic_random_access_handle.read_some_at.overload1.return_value">Return
            Value</a>
          </h6>
<p>
            The number of bytes read.
          </p>
<a name="asio.reference.windows__basic_random_access_handle.read_some_at.overload1.exceptions"></a><h6>
<a name="id1192802"></a>
            <a class="link" href="overload1.html#asio.reference.windows__basic_random_access_handle.read_some_at.overload1.exceptions">Exceptions</a>
          </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::system_error</span></dt>
<dd><p>
                  Thrown on failure. An error code of <code class="computeroutput"><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">eof</span></code>
                  indicates that the connection was closed by the peer.
                </p></dd>
</dl>
</div>
<a name="asio.reference.windows__basic_random_access_handle.read_some_at.overload1.remarks"></a><h6>
<a name="id1192872"></a>
            <a class="link" href="overload1.html#asio.reference.windows__basic_random_access_handle.read_some_at.overload1.remarks">Remarks</a>
          </h6>
<p>
            The read_some operation may not read all of the requested number of bytes.
            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
            to ensure that the requested amount of data is read before the blocking
            operation completes.
          </p>
<a name="asio.reference.windows__basic_random_access_handle.read_some_at.overload1.example"></a><h6>
<a name="id1192913"></a>
            <a class="link" href="overload1.html#asio.reference.windows__basic_random_access_handle.read_some_at.overload1.example">Example</a>
          </h6>
<p>
            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:
          </p>
<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">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>
</pre>
<p>
            See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a>
            documentation for information on reading into multiple buffers in one
            go, and how to use it with arrays, boost::array or std::vector.
          </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2003 - 2010 Christopher M. Kohlhoff<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        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>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../read_some_at.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_some_at.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>