GetAnycastIpAddressTable 函数

GetAnycastIpAddressTable 函数检索本地计算机上的任意广播 IP 地址表。

语法

NETIOAPI_API GetAnycastIpAddressTable(
  _In_  ADDRESS_FAMILY              Family,
  _Out_ PMIB_ANYCASTIPADDRESS_TABLE *Table
);

参数

• 家庭 [in]
  要检索的地址系列。

  地址系列的可能值列在 Winsock2.h 头文件中。 请注意，AF_地址系列和PF_协议系列常量的值相同（例如，AF_INET和PF_INET），因此可以使用任一常量。

  在 Windows Vista 和更高版本的 Windows 操作系统上，系列参数的可能值在 Ws2def.h 头文件中定义。 请注意，Ws2def.h 头文件自动包含在 Netioapi.h 中，不应直接使用 Ws2def.h。

  地址系列当前支持以下值：

  • AF_INET
    IPv4 地址系列。 指定此值后，此函数将返回仅包含 IPv4 条目的任何广播 IP 地址表。

  • AF_INET6
    IPv6 地址系列。 指定此值后，此函数将返回仅包含 IPv6 条目的任何广播 IP 地址表。

  • AF_UNSPEC
    未指定地址系列。 指定此值后，此函数将返回包含 IPv4 和 IPv6 条目的任何广播 IP 地址表。

• 表 [out]
  指向 MIB_ANYCASTIPADDRESS_TABLE 结构的指针，该结构包含本地计算机上的任意广播 IP 地址条目的表。

返回值

如果函数成功，GetAnycastIpAddressTable 将返回STATUS_SUCCESS。

如果函数失败， GetAnycastIpAddressTable 将返回以下错误代码之一：

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

注解

GetAnycastIpAddressTable 函数枚举本地计算机上的任意广播 IP 地址，并在MIB_ANYCASTIPADDRESS_TABLE结构中返回此信息。

Anycast IP 地址条目在 Table 参数指向的缓冲区中的MIB_ANYCASTIPADDRESS_TABLE结构中返回。 MIB_ANYCASTIPADDRESS_TABLE结构包含任何广播 IP 地址条目的任意广播 IP 地址条目计数和MIB_ANYCASTIPADDRESS_ROW结构的数组。 不再需要这些返回的结构时，驱动程序应通过调用 FreeMibTable 释放内存。

驱动程序必须将 Family 参数初始化为AF_INET、AF_INET6或AF_UNSPEC。

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

要求

目标平台	通用
版本	在 Windows Vista 及更高版本的 Windows 操作系统中可用。
头文件	Netioapi.h（包括 Netioapi.h）
库	Netio.lib
IRQL	< DISPATCH_LEVEL

另请参阅

FreeMibTable

MIB_ANYCASTIPADDRESS_ROW

MIB_ANYCASTIPADDRESS_TABLE