doc/html/boost_asio/reference/windows__basic_stream_handle/write_some/overload2.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>windows::basic_stream_handle::write_some (2 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.79.1">
   7 <link rel="home" href="../../../../boost_asio.html" title="Boost.Asio">
   8 <link rel="up" href="../write_some.html" title="windows::basic_stream_handle::write_some">
   9 <link rel="prev" href="overload1.html" title="windows::basic_stream_handle::write_some (1 of 2 overloads)">
  10 <link rel="next" href="../../windows__basic_stream_handle__rebind_executor.html" title="windows::basic_stream_handle::rebind_executor">
  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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_some.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="../../windows__basic_stream_handle__rebind_executor.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_stream_handle.write_some.overload2"></a><a class="link" href="overload2.html" title="windows::basic_stream_handle::write_some (2 of 2 overloads)">windows::basic_stream_handle::write_some
  28           (2 of 2 overloads)</a>
  29 </h5></div></div></div>
  30 <p>
  31             Write some data to the handle.
  32           </p>
  33 <pre class="programlisting">template&lt;
  34     typename <a class="link" href="../../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>&gt;
  35 std::size_t write_some(
  36     const ConstBufferSequence &amp; buffers,
  37     boost::system::error_code &amp; ec);
  38 </pre>
  39 <p>
  40             This function is used to write data to the stream handle. The function
  41             call will block until one or more bytes of the data has been written
  42             successfully, or until an error occurs.
  43           </p>
  44 <h6>
  45 <a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload2.h0"></a>
  46             <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.write_some.overload2.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">buffers</span></dt>
  52 <dd><p>
  53                   One or more data buffers to be written to the handle.
  54                 </p></dd>
  55 <dt><span class="term">ec</span></dt>
  56 <dd><p>
  57                   Set to indicate what error occurred, if any.
  58                 </p></dd>
  59 </dl>
  60 </div>
  61 <h6>
  62 <a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload2.h1"></a>
  63             <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.write_some.overload2.return_value">Return
  64             Value</a>
  65           </h6>
  66 <p>
  67             The number of bytes written. Returns 0 if an error occurred.
  68           </p>
  69 <h6>
  70 <a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload2.h2"></a>
  71             <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.write_some.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.windows__basic_stream_handle.write_some.overload2.remarks">Remarks</a>
  72           </h6>
  73 <p>
  74             The write_some operation may not transmit all of the data to the peer.
  75             Consider using the <a class="link" href="../../write.html" title="write"><code class="computeroutput">write</code></a>
  76             function if you need to ensure that all data is written before the blocking
  77             operation completes.
  78           </p>
  79 </div>
  80 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  81 <td align="left"></td>
  82 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
  83         Distributed under the Boost Software License, Version 1.0. (See accompanying
  84         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>)
  85       </p>
  86 </div></td>
  87 </tr></table>
  88 <hr>
  89 <div class="spirit-nav">
  90 <a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_some.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="../../windows__basic_stream_handle__rebind_executor.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  91 </div>
  92 </body>
  93 </html>