3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>posix::basic_stream_descriptor::io_control (2 of 2 overloads)</title>
5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="../../../../boost_asio.html" title="Boost.Asio">
8 <link rel="up" href="../io_control.html" title="posix::basic_stream_descriptor::io_control">
9 <link rel="prev" href="overload1.html" title="posix::basic_stream_descriptor::io_control (1 of 2 overloads)">
10 <link rel="next" href="../is_open.html" title="posix::basic_stream_descriptor::is_open">
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>
22 <div class="spirit-nav">
23 <a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_control.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="../is_open.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
26 <div class="titlepage"><div><div><h5 class="title">
27 <a name="boost_asio.reference.posix__basic_stream_descriptor.io_control.overload2"></a><a class="link" href="overload2.html" title="posix::basic_stream_descriptor::io_control (2 of 2 overloads)">posix::basic_stream_descriptor::io_control
28 (2 of 2 overloads)</a>
29 </h5></div></div></div>
31 <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span>
34 Perform an IO control command on the descriptor.
36 <pre class="programlisting"><span class="keyword">template</span><span class="special"><</span>
37 <span class="keyword">typename</span> <a class="link" href="../../IoControlCommand.html" title="I/O control command requirements">IoControlCommand</a><span class="special">></span>
38 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="identifier">io_control</span><span class="special">(</span>
39 <span class="identifier">IoControlCommand</span> <span class="special">&</span> <span class="identifier">command</span><span class="special">,</span>
40 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span>
43 This function is used to execute an IO control command on the descriptor.
46 <a name="boost_asio.reference.posix__basic_stream_descriptor.io_control.overload2.h0"></a>
47 <span class="phrase"><a name="boost_asio.reference.posix__basic_stream_descriptor.io_control.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_stream_descriptor.io_control.overload2.parameters">Parameters</a>
49 <div class="variablelist">
50 <p class="title"><b></b></p>
51 <dl class="variablelist">
52 <dt><span class="term">command</span></dt>
54 The IO control command to be performed on the descriptor.
56 <dt><span class="term">ec</span></dt>
58 Set to indicate what error occurred, if any.
63 <a name="boost_asio.reference.posix__basic_stream_descriptor.io_control.overload2.h1"></a>
64 <span class="phrase"><a name="boost_asio.reference.posix__basic_stream_descriptor.io_control.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_stream_descriptor.io_control.overload2.example">Example</a>
67 Getting the number of bytes ready to read:
69 <pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">posix</span><span class="special">::</span><span class="identifier">stream_descriptor</span> <span class="identifier">descriptor</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</span>
70 <span class="special">...</span>
71 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">posix</span><span class="special">::</span><span class="identifier">stream_descriptor</span><span class="special">::</span><span class="identifier">bytes_readable</span> <span class="identifier">command</span><span class="special">;</span>
72 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="identifier">ec</span><span class="special">;</span>
73 <span class="identifier">descriptor</span><span class="special">.</span><span class="identifier">io_control</span><span class="special">(</span><span class="identifier">command</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
74 <span class="keyword">if</span> <span class="special">(</span><span class="identifier">ec</span><span class="special">)</span>
75 <span class="special">{</span>
76 <span class="comment">// An error occurred.</span>
77 <span class="special">}</span>
78 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_readable</span> <span class="special">=</span> <span class="identifier">command</span><span class="special">.</span><span class="identifier">get</span><span class="special">();</span>
81 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
82 <td align="left"></td>
83 <td align="right"><div class="copyright-footer">Copyright © 2003-2014 Christopher M. Kohlhoff<p>
84 Distributed under the Boost Software License, Version 1.0. (See accompanying
85 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>)
90 <div class="spirit-nav">
91 <a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_control.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="../is_open.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>