• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>Settable serial port option requirements</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="../reference.html" title="Reference">
9<link rel="prev" href="Service.html" title="Service requirements">
10<link rel="next" href="SettableSocketOption.html" title="Settable socket option requirements">
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="Service.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="SettableSocketOption.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h3 class="title">
27<a name="boost_asio.reference.SettableSerialPortOption"></a><a class="link" href="SettableSerialPortOption.html" title="Settable serial port option requirements">Settable
28      serial port option requirements</a>
29</h3></div></div></div>
30<p>
31        In the table below, <code class="computeroutput">X</code> denotes a serial port option class, <code class="computeroutput">a</code>
32        denotes a value of <code class="computeroutput">X</code>, <code class="computeroutput">ec</code> denotes a value of type
33        <code class="computeroutput">error_code</code>, and <code class="computeroutput">s</code> denotes a value of implementation-defined
34        type <span class="emphasis"><em><code class="literal">storage</code></em></span> (where <span class="emphasis"><em><code class="literal">storage</code></em></span>
35        is the type <code class="computeroutput">DCB</code> on Windows and <code class="computeroutput">termios</code> on <span class="emphasis"><em>POSIX</em></span>
36        platforms), and <code class="computeroutput">u</code> denotes an identifier.
37      </p>
38<div class="table">
39<a name="boost_asio.reference.SettableSerialPortOption.t0"></a><p class="title"><b>Table 26. SettableSerialPortOption requirements</b></p>
40<div class="table-contents"><table class="table" summary="SettableSerialPortOption requirements">
41<colgroup>
42<col>
43<col>
44<col>
45</colgroup>
46<thead><tr>
47<th>
48                <p>
49                  expression
50                </p>
51              </th>
52<th>
53                <p>
54                  type
55                </p>
56              </th>
57<th>
58                <p>
59                  assertion/note<br> pre/post-conditions
60                </p>
61              </th>
62</tr></thead>
63<tbody><tr>
64<td>
65                <p>
66                  <code class="computeroutput">const X&amp; u = a;</code><br> <code class="computeroutput">u.store(s, ec);</code>
67                </p>
68              </td>
69<td>
70                <p>
71                  <code class="computeroutput">error_code</code>
72                </p>
73              </td>
74<td>
75                <p>
76                  Saves the value of the serial port option to the storage.<br>
77                  <br> If successful, sets <code class="computeroutput">ec</code> such that <code class="computeroutput">!ec</code>
78                  is true. If an error occurred, sets <code class="computeroutput">ec</code> such that
79                  <code class="computeroutput">!!ec</code> is true. Returns <code class="computeroutput">ec</code>.
80                </p>
81              </td>
82</tr></tbody>
83</table></div>
84</div>
85<br class="table-break">
86</div>
87<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
88<td align="left"></td>
89<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
90      Kohlhoff<p>
91        Distributed under the Boost Software License, Version 1.0. (See accompanying
92        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>)
93      </p>
94</div></td>
95</tr></table>
96<hr>
97<div class="spirit-nav">
98<a accesskey="p" href="Service.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="SettableSocketOption.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
99</div>
100</body>
101</html>
102