getAnycastIpAddressEntry 函数 (netioapi.h)

项目
08/25/2023

GetAnycastIpAddressEntry 函数检索本地计算机上现有 anycast IP 地址条目的信息。

语法

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetAnycastIpAddressEntry(
  [in, out] PMIB_ANYCASTIPADDRESS_ROW Row
);

参数

[in, out] Row

指向 anycast IP 地址条目的MIB_ANYCASTIPADDRESS_ROW 结构条目的指针。成功返回后，将使用现有 anycast IP 地址的属性更新此结构。

返回值

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

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

返回代码	说明
ERROR_FILE_NOT_FOUND	系统找不到指定的文件。如果由 Row 参数指向的MIB_ANYCASTIPADDRESS_ROW的 InterfaceLuid 或 InterfaceIndex 成员指定的网络接口 LUID 或接口索引不是本地计算机上的值，则返回此错误。
ERROR_INVALID_PARAMETER	参数不正确。如果在 Row 参数中传递 NULL 指针，Row 参数指向的MIB_ANYCASTIPADDRESS_ROW的 Address 成员未设置为有效的任意广播 IPv4 或 IPv6 地址，或者未指定 Row 参数指向的MIB_ANYCASTIPADDRESS_ROW的 InterfaceLuid 或 InterfaceIndex 成员，则返回此错误。
ERROR_NOT_FOUND	找不到元素。如果 Row 参数指向的 MIB_ANYCASTIPADDRESS_ROW 结构的 InterfaceLuid 或 InterfaceIndex 成员指定的网络接口与 MIB_ANYCASTIPADDRESS_ROW 结构中的 Address 成员中指定的 IP 地址和地址系列不匹配，则返回此错误。
ERROR_NOT_SUPPORTED	不支持该请求。如果本地计算机上没有 IPv4 堆栈，并且 Row 参数指向的 MIB_UNICASTIPADDRESS_ROW 结构的 Address 成员中指定了 IPv4 地址，则返回此错误。如果本地计算机上没有 IPv6 堆栈，并且 Address 成员中指定了 IPv6 地址，则返回此错误。
其他	使用 FormatMessage 获取返回错误的消息字符串。

注解

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

GetAnycastIpAddressEntry 函数用于检索现有的 MIB_ANYCASTIPADDRESS_ROW 结构条目。

输入时，Row 参数指向的 MIB_ANYCASTIPADDRESS_ROW 结构中的 Address 成员必须初始化为有效的任意广播 IPv4 或 IPv6 地址和系列。此外，必须初始化指向 Row 参数的 MIB_ANYCASTIPADDRESS_ROW 结构中的至少一个成员：InterfaceLuid 或 InterfaceIndex。

字段按上面列出的顺序使用。因此，如果指定了 InterfaceLuid ，则使用此成员来确定接口。如果未为 InterfaceLuid 成员设置任何值， (此成员的值) 设置为零，则接下来使用 InterfaceIndex 成员来确定接口。

在调用成功时输出时，GetAnycastIpAddressEntry 检索 anycast IP 地址的其他属性，并填写 Row 参数指向的 MIB_ANYCASTIPADDRESS_ROW 结构。

可以调用 GetAnycastIpAddressTable 函数来枚举本地计算机上的 anycast IP 地址条目。

要求

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