UdpClient Constructor (AddressFamily)

Initializes a new instance of the UdpClient class.

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

public UdpClient(
	AddressFamily family
)

Parameters

family
Type: System.Net.Sockets.AddressFamily

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

ExceptionCondition
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.

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

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft