TIdStack.DropMulticastMembership Method

Removes a socket from a multicast address group.

procedure DropMulticastMembership(
    AHandle: TIdStackSocketHandle; 
    const AGroupIP: String; 
    const ALocalIP: String; 
    const AIPVersion: TIdIPVersion = ID_DEFAULT_IP_VERSION
); virtual; abstract;

Parameters

Parameters	Description
AHandle	Handle for the socket to remove from the multicast address group.
AGroupIP	Multicast group identifier.
ALocalIP	IP address for the network adapter on the local computer system.
AIPVersion	IP address family supported for the socket transport. Default value is ID_DEFAULT_IP_VERSION.

Description

DropMulticastMembership is an abstract virtual method that defines the interface used to remove the specified socket from a multicast group. DropMulticastMembership is used to undo the action perform in AddMulticastMembership.

DropMulticastMembership must be overridden and implemented in a descendant class that provides access to the protocol stack implementation for the host operating system or platform.