Share via

GetMulticastIpAddressTable (NETIOAPI) (Compact 7)

  • Article

3/12/2014

This function retrieves the multicast IP address table on a local device.

Syntax

NETIOAPI_API
  GetMulticastIpAddressTable(
    IN ADDRESS_FAMILY  Family,
    OUT PMIB_MULTICASTIPADDRESS_TABLE*  Table
    );

Parameters

  • Family
    The address family to retrieve.

    Possible values for the address family are listed in the Winsock2.h header file. Be aware that the values for the AF_ address family and PF_ protocol family constants are identical (for example, AF_INET and PF_INET) so that you can use either constant.

    Possible values for the Family parameter are defined in the Ws2def.h header file. Be aware that the Ws2def.h header file is automatically included in Netioapi.h and you should never use Ws2def.h directly.

    The following values are currently supported for the address family:

    • AF_UNSPEC
      The address family is unspecified. When this value is specified, this function returns the multicast IP address table that contains both IPv4 and IPv6 entries.
    • AF_INET
      The IPv4 address family. When this value is specified, this function returns the multicast IP address table that contains only IPv4 entries.
    • AF_INET6
      The IPv6 address family. When this value is specified, this function returns the multicast IP address table that contains only IPv6 entries.

Return Value

Error Code Meaning

STATUS_SUCCESS

The function succeeds.

STATUS_INVALID_PARAMETER

An invalid parameter was passed to the function. This error is returned if a NULL pointer is passed in the Table parameter or the Family parameter was not specified as AF_INET, AF_INET6, or AF_UNSPEC.

STATUS_NOT_ENOUGH_MEMORY

Insufficient memory resources are available to complete the operation.

STATUS_NOT_FOUND

No anycast IP address entries, as specified in the Family parameter, were found.

STATUS_NOT_SUPPORTED

The request is not supported. This error is returned if no IPv4 stack is located on the local device and AF_INET was specified in the Family parameter, or if no IPv6 stack is located on the local device and AF_INET6 was specified in the Family parameter. This error is also returned on versions of Windows where this function is not supported.

Other

Use the FormatMessage function to obtain the message string for the returned error.

Remarks

The GetMulticastIpAddressTable function enumerates the multicast IP addresses on a local device and returns this information in a MIB_MULTICASTIPADDRESS_TABLE structure.

GetMulticastIpAddressTable returns the multicast IP address entries in a MIB_MULTICASTIPADDRESS_TABLE structure in the buffer that the Table parameter points to. The MIB_MULTICASTIPADDRESS_TABLE structure contains a multicast IP address entry count and an array of MIB_MULTICASTIPADDRESS_ROW structures for each multicast IP address entry. When these returned structures are no longer required, your driver should free the memory by calling the FreeMibTable (NETIOAPI).

Your driver must initialize the Family parameter to either AF_INET, AF_INET6, or AF_UNSPEC.

Be aware that the returned MIB_MULTICASTIPADDRESS_TABLE structure that the Table parameter points to might contain padding for alignment between the NumEntries member and the first MIB_MULTICASTIPADDRESS_ROW array entry in the Table member of the MIB_MULTICASTIPADDRESS_TABLE structure. Padding for alignment might also be present between the MIB_MULTICASTIPADDRESS_ROW array entries. Any access to a MIB_MULTICASTIPADDRESS_ROW array entry should assume padding might exist.

See Also

Reference

IP Helper Kernel-Mode Functions
GetMulticastIpAddressTable (NETIOAPI)
MIB_MULTICASTIPADDRESS_ROW
MIB_MULTICASTIPADDRESS_TABLE