This documentation is archived and is not being maintained.

SocketAddress Class

Stores serialized information from EndPoint derived classes.

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

Public Class SocketAddress
Dim instance As SocketAddress

The first 2 bytes of the underlying buffer are reserved for the AddressFamily enumerated value. When the SocketAddress is used to store a serialized IPEndPoint, the third and fourth bytes are used to store port number information. The next bytes are used to store the IP address. You can access any information within this underlying byte buffer by referring to its index position; the byte buffer uses zero-based indexing. You can also use the Family and Size properties to get the AddressFamily value and the buffer size, respectively. To view any of this information as a string, use the ToString method.

The following example demonstrates how to use SocketAddress to serialize an instance of the EndPoint class. After serialization, the underlying byte buffer of the SocketAddress contains all of the IPEndPoint state information.

   'Creates an IpEndPoint. 
   Dim ipAddress As IPAddress = Dns.Resolve("").AddressList(0)
   Dim ipLocalEndPoint As New IPEndPoint(ipAddress, 11000)

   'Serializes the IPEndPoint.  
   Dim socketAddress As SocketAddress = ipLocalEndPoint.Serialize()

   'Verifies that ipLocalEndPoint is now serialized by printing its contents.
   Console.WriteLine(("Contents of socketAddress are: " + socketAddress.ToString()))
   'Checks the Family property.
   Console.WriteLine(("The address family of socketAddress is: " + socketAddress.Family.ToString()))
   'Checks the underlying buffer size.
   Console.WriteLine(("The size of the underlying buffer is: " + socketAddress.Size.ToString()))
End Sub 'MySerializeIPEndPointClassMethod
//Creates an IpEndPoint.
IPAddress* ipAddress = Dns::Resolve(S"")->AddressList[0];
IPEndPoint* ipLocalEndPoint = new IPEndPoint(ipAddress, 11000);

//Serializes the IPEndPoint.
SocketAddress* socketAddress = ipLocalEndPoint->Serialize();

//Verifies that ipLocalEndPoint is now serialized by printing its contents.
Console::WriteLine(S"Contents of the socketAddress are: {0}", socketAddress);
//Checks the Family property.
Console::WriteLine(S"The address family of the socketAddress is: {0}",
   __box( socketAddress->Family));
//Checks the underlying buffer size.
Console::WriteLine(S"The size of the underlying buffer is: {0}",
   __box( socketAddress->Size));


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0