Jump to main content

##

# TCPIP_IGMP_GroupInfoGet Function

## C

    TCPIP_IGMP_RESULT TCPIP_IGMP_GroupInfoGet(
        TCPIP_NET_HANDLE hNet,
        IPV4_ADDR mcastAddress,
        TCPIP_IGMP_GROUP_INFO* pInfo
    );

## Description

This function returns current info about a multicast group status on a specified interface.

## Preconditions

The IGMP module must be initialized.

## Parameters

Parameters | Description
--- | ---
hNet | interface handle for which the query is made. if 0, the default interface will be used.
mcastAddress | the multicast group for which the query is made.
pInfo | Pointer to a TCPIP_IGMP_GROUP_INFO structure that contains in/out parameters. See the description of TCPIP_IGMP_GROUP_INFO.

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