2021-10-05 21:37:46 +02:00

80 lines
4.6 KiB
HTML

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_socket::release (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../release.html" title="basic_socket::release">
<link rel="prev" href="overload1.html" title="basic_socket::release (1 of 2 overloads)">
<link rel="next" href="../remote_endpoint.html" title="basic_socket::remote_endpoint">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../release.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="../remote_endpoint.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.basic_socket.release.overload2"></a><a class="link" href="overload2.html" title="basic_socket::release (2 of 2 overloads)">basic_socket::release
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Release ownership of the underlying native socket.
</p>
<pre class="programlisting">native_handle_type release(
boost::system::error_code &amp; ec);
</pre>
<p>
This function causes all outstanding asynchronous connect, send and receive
operations to finish immediately, and the handlers for cancelled operations
will be passed the <code class="computeroutput">boost::asio::error::operation_aborted</code>
error. Ownership of the native socket is then transferred to the caller.
</p>
<h6>
<a name="boost_asio.reference.basic_socket.release.overload2.h0"></a>
<span class="phrase"><a name="boost_asio.reference.basic_socket.release.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.release.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">ec</span></dt>
<dd><p>
Set to indicate what error occurred, if any.
</p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.basic_socket.release.overload2.h1"></a>
<span class="phrase"><a name="boost_asio.reference.basic_socket.release.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.release.overload2.remarks">Remarks</a>
</h6>
<p>
This function is unsupported on Windows versions prior to Windows 8.1,
and will fail with <code class="computeroutput">boost::asio::error::operation_not_supported</code>
on these platforms.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2021 Christopher
M. Kohlhoff<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../release.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="../remote_endpoint.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>