summaryrefslogtreecommitdiff
path: root/libs/asio/doc/requirements/IoControlCommand.qbk
blob: 17e52ae4a1e7285903dd2611b78914d48b0b0648 (plain)
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
[/
 / Copyright (c) 2003-2015 Christopher M. Kohlhoff (chris at kohlhoff dot com)
 /
 / Distributed under the Boost Software License, Version 1.0. (See accompanying
 / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 /]

[section:IoControlCommand I/O control command requirements]

In the table below, `X` denotes an I/O control command class, `a` denotes a
value of `X`, and `u` denotes an identifier.

[table IoControlCommand requirements
  [[expression] [type] [assertion/note\npre/post-conditions]]
  [
    [`a.name();`]
    [`int`]
    [
      Returns a value suitable for passing as the /request/ argument to
      __POSIX__ __ioctl__ (or equivalent).
    ]
  ]
  [
    [`a.data();`]
    [a pointer, convertible to `void*`]
    [
    ]
  ]
]

[endsect]