]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
1 | [/ |
2 | / Copyright (c) 2003-2016 Christopher M. Kohlhoff (chris at kohlhoff dot com) | |
3 | / | |
4 | / Distributed under the Boost Software License, Version 1.0. (See accompanying | |
5 | / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) | |
6 | /] | |
7 | ||
8 | [section:GettableSerialPortOption Gettable serial port option requirements] | |
9 | ||
10 | In the table below, `X` denotes a serial port option class, `a` denotes a value | |
11 | of `X`, `ec` denotes a value of type `error_code`, and `s` denotes a value of | |
12 | implementation-defined type ['[^storage]] (where ['[^storage]] is the type | |
13 | `DCB` on Windows and `termios` on __POSIX__ platforms), and `u` denotes an | |
14 | identifier. | |
15 | ||
16 | [table GettableSerialPortOption requirements | |
17 | [[expression] [type] [assertion/note\npre/post-conditions]] | |
18 | [ | |
19 | [ | |
20 | `const `['[^storage]]`& u = s;`\n | |
21 | `a.load(u, ec);` | |
22 | ] | |
23 | [`error_code`] | |
24 | [ | |
25 | Retrieves the value of the serial port option from the storage.\n | |
26 | \n | |
27 | If successful, sets `ec` such that `!ec` is true. If an error occurred, | |
28 | sets `ec` such that `!!ec` is true. Returns `ec`. | |
29 | ] | |
30 | ] | |
31 | ] | |
32 | ||
33 | [endsect] |