doc/html/boost_asio/reference/serial_port/write_some/overload1.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>serial_port::write_some (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../write_some.html" title="serial_port::write_some">
<link rel="prev" href="../write_some.html" title="serial_port::write_some">
<link rel="next" href="overload2.html" title="serial_port::write_some (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="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../write_some.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.serial_port.write_some.overload1"></a><a class="link" href="overload1.html" title="serial_port::write_some (1 of 2 overloads)">serial_port::write_some
          (1 of 2 overloads)</a>
</h5></div></div></div>
<p>
            Write some data to the serial port.
          </p>
<pre class="programlisting">template&lt;
    typename <a class="link" href="../../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>&gt;
std::size_t write_some(
    const ConstBufferSequence &amp; buffers);
</pre>
<p>
            This function is used to write data to the serial port. The function
            call will block until one or more bytes of the data has been written
            successfully, or until an error occurs.
          </p>
<h6>
<a name="boost_asio.reference.serial_port.write_some.overload1.h0"></a>
            <span class="phrase"><a name="boost_asio.reference.serial_port.write_some.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.serial_port.write_some.overload1.parameters">Parameters</a>
          </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">buffers</span></dt>
<dd><p>
                  One or more data buffers to be written to the serial port.
                </p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.serial_port.write_some.overload1.h1"></a>
            <span class="phrase"><a name="boost_asio.reference.serial_port.write_some.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.serial_port.write_some.overload1.return_value">Return
            Value</a>
          </h6>
<p>
            The number of bytes written.
          </p>
<h6>
<a name="boost_asio.reference.serial_port.write_some.overload1.h2"></a>
            <span class="phrase"><a name="boost_asio.reference.serial_port.write_some.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.serial_port.write_some.overload1.exceptions">Exceptions</a>
          </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">boost::system::system_error</span></dt>
<dd><p>
                  Thrown on failure. An error code of <code class="computeroutput">boost::asio::error::eof</code>
                  indicates that the connection was closed by the peer.
                </p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.serial_port.write_some.overload1.h3"></a>
            <span class="phrase"><a name="boost_asio.reference.serial_port.write_some.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.serial_port.write_some.overload1.remarks">Remarks</a>
          </h6>
<p>
            The write_some operation may not transmit all of the data to the peer.
            Consider using the <a class="link" href="../../write.html" title="write"><code class="computeroutput">write</code></a>
            function if you need to ensure that all data is written before the blocking
            operation completes.
          </p>
<h6>
<a name="boost_asio.reference.serial_port.write_some.overload1.h4"></a>
            <span class="phrase"><a name="boost_asio.reference.serial_port.write_some.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.serial_port.write_some.overload1.example">Example</a>
          </h6>
<p>
            To write a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
            function as follows:
          </p>
<pre class="programlisting">serial_port.write_some(boost::asio::buffer(data, size));
</pre>
<p>
            See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
            documentation for information on writing 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-2018 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="../write_some.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>