doc/html/boost_asio/reference/IoControlCommand.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>I/O control command 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="InternetProtocol.html" title="Internet protocol requirements">
  10 <link rel="next" href="IoObjectService.html" title="I/O object service 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="InternetProtocol.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="IoObjectService.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.IoControlCommand"></a><a class="link" href="IoControlCommand.html" title="I/O control command requirements">I/O control command
  28       requirements</a>
  29 </h3></div></div></div>
  30 <p>
  31         In the table below, <code class="computeroutput"><span class="identifier">X</span></code> denotes
  32         an I/O control command class, <code class="computeroutput"><span class="identifier">a</span></code>
  33         denotes a value of <code class="computeroutput"><span class="identifier">X</span></code>, and
  34         <code class="computeroutput"><span class="identifier">u</span></code> denotes an identifier.
  35       </p>
  36 <div class="table">
  37 <a name="boost_asio.reference.IoControlCommand.t0"></a><p class="title"><b>Table&#160;16.&#160;IoControlCommand requirements</b></p>
  38 <div class="table-contents"><table class="table" summary="IoControlCommand requirements">
  39 <colgroup>
  40 <col>
  41 <col>
  42 <col>
  43 </colgroup>
  44 <thead><tr>
  45 <th>
  46                 <p>
  47                   expression
  48                 </p>
  49               </th>
  50 <th>
  51                 <p>
  52                   type
  53                 </p>
  54               </th>
  55 <th>
  56                 <p>
  57                   assertion/note<br> pre/post-conditions
  58                 </p>
  59               </th>
  60 </tr></thead>
  61 <tbody>
  62 <tr>
  63 <td>
  64                 <p>
  65                   <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">name</span><span class="special">();</span></code>
  66                 </p>
  67               </td>
  68 <td>
  69                 <p>
  70                   <code class="computeroutput"><span class="keyword">int</span></code>
  71                 </p>
  72               </td>
  73 <td>
  74                 <p>
  75                   Returns a value suitable for passing as the <span class="emphasis"><em>request</em></span>
  76                   argument to <span class="emphasis"><em>POSIX</em></span> <a href="http://www.opengroup.org/onlinepubs/000095399/functions/ioctl.html" target="_top"><code class="computeroutput"><span class="identifier">ioctl</span><span class="special">()</span></code></a>
  77                   (or equivalent).
  78                 </p>
  79               </td>
  80 </tr>
  81 <tr>
  82 <td>
  83                 <p>
  84                   <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">data</span><span class="special">();</span></code>
  85                 </p>
  86               </td>
  87 <td>
  88                 <p>
  89                   a pointer, convertible to <code class="computeroutput"><span class="keyword">void</span><span class="special">*</span></code>
  90                 </p>
  91               </td>
  92 <td>
  93               </td>
  94 </tr>
  95 </tbody>
  96 </table></div>
  97 </div>
  98 <br class="table-break">
  99 </div>
 100 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 101 <td align="left"></td>
 102 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
 103         Distributed under the Boost Software License, Version 1.0. (See accompanying
 104         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>)
 105       </p>
 106 </div></td>
 107 </tr></table>
 108 <hr>
 109 <div class="spirit-nav">
 110 <a accesskey="p" href="InternetProtocol.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="IoObjectService.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 111 </div>
 112 </body>
 113 </html>