2.2.1.2.171 IGMP_MIB_GET_INPUT_DATA

  • Article

The IGMP_MIB_GET_INPUT_DATA structure is passed as input data for the following methods:

All IP addresses MUST be in network order.

 typedef struct _IGMP_MIB_GET_INPUT_DATA {
   DWORD TypeId;
   USHORT Flags;
   USHORT Signature;
   DWORD IfIndex;
   DWORD RasClientAddr;
   DWORD GroupAddr;
   DWORD Count;
 } IGMP_MIB_GET_INPUT_DATA,
  *PIGMP_MIB_GET_INPUT_DATA;

TypeID: Specifies the type of entry being requested. It MUST be one of the following, otherwise an error is returned.

Value

Meaning

IGMP_IF_STATS_ID

0x00000004

The Internet Group Management Protocol (IGMP) statistics for an interface. If TypeID is set to this value, Count MUST be nonzero.

IGMP_IF_GROUPS_LIST_ID

0x00000005

The list of multicast group members on an interface. If TypeID is set to this value, Count MUST be nonzero.

IGMP_GROUP_IFS_LIST_ID

0x00000006

The list of interfaces joined for a group. If TypeID is set to this value, Count MUST be nonzero and GroupAddr MUST match a valid existing IGMP group address.

IGMP_PROXY_IF_INDEX_ID

0x00000007

Returns the index of the interface owned by the IGMP proxy.

RMIBEntryGetNext is invalid as there is only one proxy interface and ERROR_NO_MORE_ITEMS is returned.

Flags: This MUST be one of the following combinations, otherwise an error is returned.

Value

Meaning

IGMP_ENUM_FOR_RAS_CLIENTS

0x00000001

Enumerate for RAS clients only.

IGMP_ENUM_ONE_ENTRY

0x00000002

Return only one interface group entry.

IGMP_ENUM_ALL_INTERFACES_GROUPS

0x00000004

Enumerate all interfaces. If enumeration reaches end of an interface, it will go to the next interface.

IGMP_ENUM_ALL_TABLES

0x00000010

Enumerate all tables.

IGMP_ENUM_SUPPORT_FORMAT_IGMPV3

0x00000010

Set if IGMPv3 is supported.

Signature: This MUST be set to zero (0).

IfIndex: The index of the interface for which information needs to be retrieved.

RasClientAddr: The address of the RAS client for which information needs to be retrieved.

GroupAddr: The IGMP group address for which information needs to be retrieved.

Count: The count of entries that need to be retrieved.