SocketAddress Class


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Stores serialized information from EndPoint derived classes.

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


public ref class SocketAddress 


Creates a new instance of the SocketAddress class for the given address family.

System_CAPS_pubmethodSocketAddress(AddressFamily, Int32)

Creates a new instance of the SocketAddress class using the specified address family and buffer size.


Gets the AddressFamily enumerated value of the current SocketAddress.


Gets or sets the specified index element in the underlying buffer.


Gets the underlying buffer size of the SocketAddress.


Determines whether the specified Object is equal to the current Object.(Overrides Object::Equals(Object^).)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.(Overrides Object::GetHashCode().)


Gets the Type of the current instance.(Inherited from Object.)


Creates a shallow copy of the current Object.(Inherited from Object.)


Returns information about the socket address.(Overrides Object::ToString().)

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.
IPAddress^ ipAddress = Dns::Resolve( "" )->AddressList[ 0 ];
IPEndPoint^ ipLocalEndPoint = gcnew IPEndPoint( ipAddress,11000 );

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

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

Universal Windows Platform
Available since 10
.NET Framework
Available since 1.1
Available since 2.0
Windows Phone Silverlight
Available since 7.1

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

Return to top