<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>write (4 of 16 overloads)</title> <link rel="stylesheet" href="../../../boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> <link rel="home" href="../../../index.html" title="Asio"> <link rel="up" href="../write.html" title="write"> <link rel="prev" href="overload3.html" title="write (3 of 16 overloads)"> <link rel="next" href="overload5.html" title="write (5 of 16 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="overload3.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../write.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="overload5.html"><img src="../../../next.png" alt="Next"></a> </div> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> <a name="asio.reference.write.overload4"></a><a class="link" href="overload4.html" title="write (4 of 16 overloads)">write (4 of 16 overloads)</a> </h4></div></div></div> <p> Write a certain amount of data to a stream before returning. </p> <pre class="programlisting">template< typename <a class="link" href="../SyncWriteStream.html" title="Buffer-oriented synchronous write stream requirements">SyncWriteStream</a>, typename <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>, typename <a class="link" href="../CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>> std::size_t write( SyncWriteStream & s, const ConstBufferSequence & buffers, CompletionCondition completion_condition, asio::error_code & ec, typename enable_if< is_const_buffer_sequence< ConstBufferSequence >::value >::type * = 0); </pre> <p> This function is used to write a certain number of bytes of data to a stream. The call will block until one of the following conditions is true: </p> <div class="itemizedlist"><ul class="itemizedlist" type="disc"> <li class="listitem"> All of the data in the supplied buffers has been written. That is, the bytes transferred is equal to the sum of the buffer sizes. </li> <li class="listitem"> The completion_condition function object returns 0. </li> </ul></div> <p> This operation is implemented in terms of zero or more calls to the stream's write_some function. </p> <h6> <a name="asio.reference.write.overload4.h0"></a> <span><a name="asio.reference.write.overload4.parameters"></a></span><a class="link" href="overload4.html#asio.reference.write.overload4.parameters">Parameters</a> </h6> <div class="variablelist"> <p class="title"><b></b></p> <dl> <dt><span class="term">s</span></dt> <dd><p> The stream to which the data is to be written. The type must support the SyncWriteStream concept. </p></dd> <dt><span class="term">buffers</span></dt> <dd><p> One or more buffers containing the data to be written. The sum of the buffer sizes indicates the maximum number of bytes to write to the stream. </p></dd> <dt><span class="term">completion_condition</span></dt> <dd> <p> The function object to be called to determine whether the write operation is complete. The signature of the function object must be: </p> <pre class="programlisting">std::size_t completion_condition( // Result of latest write_some operation. const asio::error_code& error, // Number of bytes transferred so far. std::size_t bytes_transferred ); </pre> <p> A return value of 0 indicates that the write operation is complete. A non-zero return value indicates the maximum number of bytes to be written on the next call to the stream's write_some function. </p> </dd> <dt><span class="term">ec</span></dt> <dd><p> Set to indicate what error occurred, if any. </p></dd> </dl> </div> <h6> <a name="asio.reference.write.overload4.h1"></a> <span><a name="asio.reference.write.overload4.return_value"></a></span><a class="link" href="overload4.html#asio.reference.write.overload4.return_value">Return Value</a> </h6> <p> The number of bytes written. If an error occurs, returns the total number of bytes successfully transferred prior to the error. </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 © 2003-2020 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="overload3.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../write.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="overload5.html"><img src="../../../next.png" alt="Next"></a> </div> </body> </html>