FB_UDPPeer - Method JoinMulticastGroup

Overview

Type:

Method

Available as of:

V1.0.4.0

Task

Join a multicast group for receiving messages.

Functional Description

Joins a multicast group for receiving messages sent to that group address by sending an IGMP AddMembership message (Internet Group Management Protocol).

The BOOL return value is TRUE if the function was executed successfully. Evaluate the property Result, in case the return value is FALSE.

NOTE: In order to receive multicast messages, the Bind method must first be used with a null string for the input i_sLocalIp, or leave the input unconnected.

Also refer to the implementation examples.

Interface

Input

Data type

Valid range

Description

i_sInterfaceIP

STRING(15)

-

IP address of the interface to join the multicast group on.

i_sGroupIP

STRING(15)

-

Multicast address of the group to be joined.