TCPIP_IGMP_GroupSet Function

C

TCPIP_IGMP_RESULT TCPIP_IGMP_GroupsGet(
    IPV4_ADDR* groupsList, 
    int listSize, 
    int* pnGroups
);

Description

This function returns the current list of the multicast groups that are subscribed with IGMP. Additional details about a specific group could be optained with TCPIP_IGMP_GroupInfoGet.

Preconditions

The IGMP module must be initialized.

Parameters

ParametersDescription
groupsListPointer to an array of IPv4 addresses that will receive the subscribed multicast groups. Could be NULL if listSize == 0.
listSizeThe number of entries in the groupsList array. If 0, the groupsList will not be used/populated.
pnGroupsAddress to store the number of all subscribed groups. Could be NULL if not needed.

Returns

  • TCPIP_IGMP_OK if - if the call succeeds and the pInfo is populated.

  • TCPIP_IGMP_GROUP_INVALID - if no such multicast group exists.

  • TCPIP_IGMP_ARG_ERROR - pInfo is NULL.

  • TCPIP_IGMP_IF_ERROR - no such interface.

Remarks

None.