UdpClient.DropMulticastGroup Method (IPAddress, Int32)


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

Leaves a multicast group.

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

public void DropMulticastGroup(
	IPAddress multicastAddr,
	int ifindex


Type: System.Net.IPAddress

The IPAddress of the multicast group to leave.

Type: System.Int32

The local address of the multicast group to leave.

Exception Condition

The underlying Socket has been closed.


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


The IP address is not compatible with the AddressFamily value that defines the addressing scheme of the socket.


multicastAddr is null.

The DropMulticastGroup method withdraws the UdpClient from the multicast group identified by the specified IPAddress. After calling the DropMulticastGroup method, the underlying Socket sends an Internet Group Management Protocol (IGMP) packet to the router, removing the router from the multicast group. After a UdpClient withdraws from the group, it will no longer be able to receive datagrams sent to that group.


If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code. After 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 following code example demonstrates how to drop a multicast group by providing a multicast address.

// Send data to ClientTarget.
Console.WriteLine("\nThe ClientOriginator sent:\n");
Send.OriginatorSendData(clientOriginator, m_ClientTargetdest);

// Receive data from ClientTarget
Ret = Receive.ReceiveUntilStop(clientOriginator);

// Stop the ClientTarget thread

// Abandon the multicast group.

.NET Framework
Available since 1.1
Return to top