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