• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>write_at (6 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="../write_at.html" title="write_at">
9<link rel="prev" href="overload5.html" title="write_at (5 of 8 overloads)">
10<link rel="next" href="overload7.html" title="write_at (7 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="overload5.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_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="overload7.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.write_at.overload6"></a><a class="link" href="overload6.html" title="write_at (6 of 8 overloads)">write_at (6
28        of 8 overloads)</a>
29</h4></div></div></div>
30<p>
31          Write all of the supplied data at the specified offset before returning.
32        </p>
33<pre class="programlisting">template&lt;
34    typename <a class="link" href="../SyncRandomAccessWriteDevice.html" title="Buffer-oriented synchronous random-access write device requirements">SyncRandomAccessWriteDevice</a>,
35    typename Allocator&gt;
36std::size_t write_at(
37    SyncRandomAccessWriteDevice &amp; d,
38    uint64_t offset,
39    basic_streambuf&lt; Allocator &gt; &amp; b,
40    boost::system::error_code &amp; ec);
41</pre>
42<p>
43          This function is used to write a certain number of bytes of data to a random
44          access device at a specified offset. The call will block until one of the
45          following conditions is true:
46        </p>
47<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
48<li class="listitem">
49              All of the data in the supplied <a class="link" href="../basic_streambuf.html" title="basic_streambuf"><code class="computeroutput">basic_streambuf</code></a>
50              has been written.
51            </li>
52<li class="listitem">
53              An error occurred.
54            </li>
55</ul></div>
56<p>
57          This operation is implemented in terms of zero or more calls to the device's
58          write_some_at function.
59        </p>
60<h6>
61<a name="boost_asio.reference.write_at.overload6.h0"></a>
62          <span class="phrase"><a name="boost_asio.reference.write_at.overload6.parameters"></a></span><a class="link" href="overload6.html#boost_asio.reference.write_at.overload6.parameters">Parameters</a>
63        </h6>
64<div class="variablelist">
65<p class="title"><b></b></p>
66<dl class="variablelist">
67<dt><span class="term">d</span></dt>
68<dd><p>
69                The device to which the data is to be written. The type must support
70                the SyncRandomAccessWriteDevice concept.
71              </p></dd>
72<dt><span class="term">offset</span></dt>
73<dd><p>
74                The offset at which the data will be written.
75              </p></dd>
76<dt><span class="term">b</span></dt>
77<dd><p>
78                The <a class="link" href="../basic_streambuf.html" title="basic_streambuf"><code class="computeroutput">basic_streambuf</code></a>
79                object from which data will be written.
80              </p></dd>
81<dt><span class="term">ec</span></dt>
82<dd><p>
83                Set to indicate what error occurred, if any.
84              </p></dd>
85</dl>
86</div>
87<h6>
88<a name="boost_asio.reference.write_at.overload6.h1"></a>
89          <span class="phrase"><a name="boost_asio.reference.write_at.overload6.return_value"></a></span><a class="link" href="overload6.html#boost_asio.reference.write_at.overload6.return_value">Return Value</a>
90        </h6>
91<p>
92          The number of bytes transferred.
93        </p>
94<h6>
95<a name="boost_asio.reference.write_at.overload6.h2"></a>
96          <span class="phrase"><a name="boost_asio.reference.write_at.overload6.remarks"></a></span><a class="link" href="overload6.html#boost_asio.reference.write_at.overload6.remarks">Remarks</a>
97        </h6>
98<p>
99          This overload is equivalent to calling:
100        </p>
101<pre class="programlisting">boost::asio::write_at(
102    d, 42, b,
103    boost::asio::transfer_all(), ec);
104</pre>
105</div>
106<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
107<td align="left"></td>
108<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
109      Kohlhoff<p>
110        Distributed under the Boost Software License, Version 1.0. (See accompanying
111        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>)
112      </p>
113</div></td>
114</tr></table>
115<hr>
116<div class="spirit-nav">
117<a accesskey="p" href="overload5.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_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="overload7.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
118</div>
119</body>
120</html>
121