1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_socket::local_endpoint (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.79.1"> 7<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> 8<link rel="up" href="../local_endpoint.html" title="basic_socket::local_endpoint"> 9<link rel="prev" href="overload1.html" title="basic_socket::local_endpoint (1 of 2 overloads)"> 10<link rel="next" href="../lowest_layer.html" title="basic_socket::lowest_layer"> 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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../local_endpoint.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="../lowest_layer.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h5 class="title"> 27<a name="boost_asio.reference.basic_socket.local_endpoint.overload2"></a><a class="link" href="overload2.html" title="basic_socket::local_endpoint (2 of 2 overloads)">basic_socket::local_endpoint 28 (2 of 2 overloads)</a> 29</h5></div></div></div> 30<p> 31 Get the local endpoint of the socket. 32 </p> 33<pre class="programlisting">endpoint_type local_endpoint( 34 boost::system::error_code & ec) const; 35</pre> 36<p> 37 This function is used to obtain the locally bound endpoint of the socket. 38 </p> 39<h6> 40<a name="boost_asio.reference.basic_socket.local_endpoint.overload2.h0"></a> 41 <span class="phrase"><a name="boost_asio.reference.basic_socket.local_endpoint.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.local_endpoint.overload2.parameters">Parameters</a> 42 </h6> 43<div class="variablelist"> 44<p class="title"><b></b></p> 45<dl class="variablelist"> 46<dt><span class="term">ec</span></dt> 47<dd><p> 48 Set to indicate what error occurred, if any. 49 </p></dd> 50</dl> 51</div> 52<h6> 53<a name="boost_asio.reference.basic_socket.local_endpoint.overload2.h1"></a> 54 <span class="phrase"><a name="boost_asio.reference.basic_socket.local_endpoint.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.local_endpoint.overload2.return_value">Return 55 Value</a> 56 </h6> 57<p> 58 An object that represents the local endpoint of the socket. Returns a 59 default-constructed endpoint object if an error occurred. 60 </p> 61<h6> 62<a name="boost_asio.reference.basic_socket.local_endpoint.overload2.h2"></a> 63 <span class="phrase"><a name="boost_asio.reference.basic_socket.local_endpoint.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.local_endpoint.overload2.example">Example</a> 64 </h6> 65<pre class="programlisting">boost::asio::ip::tcp::socket socket(my_context); 66... 67boost::system::error_code ec; 68boost::asio::ip::tcp::endpoint endpoint = socket.local_endpoint(ec); 69if (ec) 70{ 71 // An error occurred. 72} 73</pre> 74</div> 75<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 76<td align="left"></td> 77<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 78 Kohlhoff<p> 79 Distributed under the Boost Software License, Version 1.0. (See accompanying 80 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>) 81 </p> 82</div></td> 83</tr></table> 84<hr> 85<div class="spirit-nav"> 86<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../local_endpoint.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="../lowest_layer.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 87</div> 88</body> 89</html> 90
