Export (0) Print
Expand All

Socket.LocalEndPoint Property

Gets the local endpoint.

Namespace: System.Net.Sockets
Assembly: System (in system.dll)

public EndPoint LocalEndPoint { get; }
/** @property */
public EndPoint get_LocalEndPoint ()

public function get LocalEndPoint () : EndPoint

Not applicable.

Property Value

The EndPoint that the Socket is using for communications.

Exception typeCondition

SocketException

An error occurred when attempting to access the socket. See the Remarks section for more information.

ObjectDisposedException

The Socket has been closed.

The LocalEndPoint property gets an EndPoint that contains the local IP address and port number to which your Socket is bound. You must cast this EndPoint to an IPEndPoint before retrieving any information. You can then call the System.Net.IPEndPoint.Address method to retrieve the local IPAddress, and the System.Net.IPEndPoint.Port method to retrieve the local port number.

The LocalEndPoint property is usually set after you make a call to the Bind method. If you allow the system to assign your socket's local IP address and port number, the LocalEndPoint property will be set after the first I/O operation. For connection-oriented protocols, the first I/O operation would be a call to the Connect or Accept method. For connectionless protocols, the first I/O operation would be any of the send or receive calls.

NoteNote:

If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code. After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation in the MSDN library for a detailed description of the error.

NoteNote:

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing.

The following code example retrieves and displays the local and remote endpoints.

s.Connect (lep);

// Using the RemoteEndPoint property.
Console.WriteLine ("I am connected to " + IPAddress.Parse (((IPEndPoint)s.RemoteEndPoint).Address.ToString ()) + "on port number " + ((IPEndPoint)s.RemoteEndPoint).Port.ToString ());

// Using the LocalEndPoint property.
Console.WriteLine ("My local IpAddress is :" + IPAddress.Parse (((IPEndPoint)s.LocalEndPoint).Address.ToString ()) + "I am connected on port number " + ((IPEndPoint)s.LocalEndPoint).Port.ToString ());


s.Connect(lep);
// Using the RemoteEndPoint property.
Console.WriteLine("I am connected to " 
    + IPAddress.Parse(((IPEndPoint)s.get_RemoteEndPoint()).
    get_Address().ToString()) + "on port number " 
    + ((IPEndPoint)s.get_RemoteEndPoint()).get_Port());
// Using the LocalEndPoint property.
Console.WriteLine("My local IpAddress is :" 
    + IPAddress.Parse(((IPEndPoint)s.get_LocalEndPoint()).
    get_Address().ToString()) + "I am connected on port number " 
    + ((IPEndPoint)s.get_LocalEndPoint()).get_Port());

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft