getMulticastIpAddressTable 函数 (netioapi.h)

GetMulticastIpAddressTable 函数检索本地计算机上的多播 IP 地址表。

语法

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetMulticastIpAddressTable(
  [in]  ADDRESS_FAMILY                Family,
  [out] PMIB_MULTICASTIPADDRESS_TABLE *Table
);

参数

[in] Family

要检索的地址系列。

Winsock2.h 头文件中列出了地址系列的可能值。 请注意,AF_地址系列和PF_协议系列常量的值 (相同,例如 ,AF_INETPF_INET) ,因此可以使用任一常量。

在为 Windows Vista 及更高版本发布的Windows SDK上,头文件的组织已更改,Ws2def.h 头文件中定义了此成员的可能值。 请注意, Ws2def.h 头文件自动包含在 Winsock2.h 中,不应直接使用。

当前支持的值是 AF_INETAF_INET6AF_UNSPEC

含义
AF_UNSPEC
0
未指定地址系列。 指定此参数后,此函数返回包含 IPv4 和 IPv6 条目的多播 IP 地址表。
AF_INET
2
Internet 协议版本 4 (IPv4) 地址系列。 指定此参数后,此函数返回仅包含 IPv4 条目的多播 IP 地址表。
AF_INET6
23
Internet 协议版本 6 (IPv6) 地址系列。 指定此参数时,此函数返回仅包含 IPv6 条目的多播 IP 地址表。

[out] Table

指向 MIB_MULTICASTIPADDRESS_TABLE 结构的指针,该结构包含本地计算机上的任意播 IP 地址条目的表。

返回值

如果函数成功,则返回值NO_ERROR。

如果函数失败,则返回值为以下错误代码之一。

返回代码 说明
ERROR_INVALID_PARAMETER
向该函数传递了无效参数。 如果在 Table 参数中传递 NULL 指针,或者未将 Family 参数指定为 AF_INETAF_INET6AF_UNSPEC,则返回此错误。
ERROR_NOT_ENOUGH_MEMORY
可用内存资源不足,无法完成该操作。
ERROR_NOT_FOUND
未找到 Family 参数中指定的任何播 IP 地址条目。
ERROR_NOT_SUPPORTED
不支持该请求。 如果本地计算机上没有 IPv4 堆栈,并且 Family 参数中指定了AF_INET,则返回此错误。 如果本地计算机上没有 IPv6 堆栈,并且 Family 参数中指定了AF_INET6,也会返回此错误。 在不支持此函数的 Windows 版本上也会返回此错误。
其他
使用 FormatMessage 获取返回错误的消息字符串。

注解

GetMulticastIpAddressTable 函数在 Windows Vista 及更高版本上定义。

The
GetMulticastIpAddressTable 函数枚举本地系统上的多播 IP 地址,并在 MIB_MULTICASTIPADDRESS_TABLE 结构中返回此信息。

多播 IP 地址条目以 table 参数指向的缓冲区中的MIB_MULTICASTIPADDRESS_TABLE结构返回。 MIB_MULTICASTIPADDRESS_TABLE 结构包含多播 IP 地址条目计数和每个多播 IP 地址条目的MIB_MULTICASTIPADDRESS_ROW结构数组。 如果不再需要这些返回的结构,请通过调用 FreeMibTable 释放内存。

Family 参数必须初始化为AF_INETAF_INET6AF_UNSPEC

请注意,Table 参数指向的返回MIB_MULTICASTIPADDRESS_TABLE结构可能包含 NumEntries 成员与 MIB_MULTICASTIPADDRESS_TABLE 结构的Table 成员中的第一个MIB_MULTICASTIPADDRESS_ROW数组条目之间的对齐填充。 MIB_MULTICASTIPADDRESS_ROW数组条目之间也可能存在对齐填充。 对 MIB_MULTICASTIPADDRESS_ROW 数组条目的任何访问都应假定可能存在填充。

要求

要求
最低受支持的客户端 Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2008 [仅限桌面应用]
目标平台 Windows
标头 netioapi.h (包括 Iphlpapi.h)
Library Iphlpapi.lib
DLL Iphlpapi.dll

另请参阅

FreeMibTable

GetMulticastIpAddressEntry

MIB_MULTICASTIPADDRESS_ROW

MIB_MULTICASTIPADDRESS_TABLE