UdpClient Constructor (AddressFamily)

 
System_CAPS_noteNote

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

Initializes a new instance of the UdpClient class.

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

Public Sub New (
	family As AddressFamily
)

Parameters

family
Type: System.Net.Sockets.AddressFamily

One of the AddressFamily values that specifies the addressing scheme of the socket.

Exception Condition
ArgumentException

family is not InterNetwork or InterNetworkV6.

SocketException

An error occurred when accessing the socket. See the Remarks section for more information.

The family parameter determines whether the listener uses an IP version 4 address (IPv4) or an IP version 6 (IPv6) address. To use an IPv4 address, pass the InterNetwork value. To use an IPv6 address, pass the InterNetworkV6 value. Passing any other value will cause the method to throw an ArgumentException.

If this constructor is used, the UdpClient instance is set with the address family specified by the family parameter that cannot be changed or overwritten by a connect method call with a different address family.

System_CAPS_noteNote

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

The UdpClient.UdpClient(AddressFamily) is not suitable for joining a multicast group because it does not perform socket binding.

.NET Framework
Available since 1.1
Return to top
Show: