GetAnycastIpAddressEntry 函数

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

语法

NETIOAPI_API GetAnycastIpAddressEntry(
  _Inout_ PMIB_ANYCASTIPADDRESS_ROW Row
);

参数

  • [in, out]
    指向任何广播 IP 地址条目的 MIB_ANYCASTIPADDRESS_ROW 结构条目的指针。 成功返回后,此结构会使用现有任意广播 IP 地址的属性进行更新。

返回值

GetAnycastIpAddressEntry 如果函数成功,则返回STATUS_SUCCESS。

如果函数失败,GetAnycastIpAddressEntry 返回以下错误代码之一:

返回代码 描述
STATUS_INVALID_PARAMETER

将无效参数传递给函数。 如果在 Row 参数中传递 NULL 指针,则返回此错误: 地址MIB_ANYCASTIPADDRESS_ROW 结构的成员, 参数指向的成员未设置为有效的任何播 IPv4 或 IPv6 地址,或者未指定 InterfaceLuidInterfaceIndex MIB_ANYCASTIPADDRESS_ROW 成员。

STATUS_NOT_FOUND

找不到指定的接口。 如果函数找不到由 InterfaceLuidInterfaceIndex MIB_ANYCASTIPADDRESS_ROW 结构的成员指定的网络接口,Row 参数指向的MIB_ANYCASTIPADDRESS_ROW成员,则返回此错误。

STATUS_NOT_SUPPORTED

不支持该请求。 如果本地计算机上没有 IPv4 堆栈,并且MIB_UNICASTIPADDRESS_ROW结构 参数指向的 地址 成员中指定了 IPv4 地址,或者没有 IPv6 堆栈位于本地计算机上,并在 地址 成员中指定了 IPv6 地址,则返回此错误。

其他

使用 FormatMessage 函数获取返回的错误的消息字符串。

言论

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

在输入时,驱动程序必须初始化 参数指向的MIB_ANYCASTIPADDRESS_ROW结构的以下成员。

  • 地址
    设置为有效的 IPv4 或 IPv6 任意广播地址和系列。

  • InterfaceLuidInterfaceIndex
    这些成员按前面列出的顺序使用。 因此,如果指定了 InterfaceLuid,则使用此成员来确定接口。 如果未为 InterfaceLuid 成员设置值(此成员的值设置为零),则接下来使用 InterfaceIndex 成员来确定接口。

在输出中,调用成功时,GetAnycastIpAddressEntry 检索任何播 IP 地址的其他属性,并填写 参数指向的MIB_ANYCASTIPADDRESS_ROW结构。

驱动程序可以调用 GetAnycastIpAddressTable 函数来枚举本地计算机上的任意广播 IP 地址条目。

要求

目标平台

通用

版本

在 Windows Vista 和更高版本的 Windows作系统中可用。

页眉

Netioapi.h (包括 Netioapi.h)

图书馆

Netio.lib

IRQL

< DISPATCH_LEVEL

另请参阅

CreateAnycastIpAddressEntry

DeleteAnycastIpAddressEntry

GetAnycastIpAddressTable

MIB_ANYCASTIPADDRESS_ROW

MIB_ANYCASTIPADDRESS_TABLE