GetUnicastIpAddressEntry 函数

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

语法

NETIOAPI_API GetUnicastIpAddressEntry(
  _Inout_ PMIB_UNICASTIPADDRESS_ROW Row
);

参数

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

返回值

GetUnicastIpAddressEntry 如果函数成功,则返回 STATUS_SUCCESS

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

返回代码 描述
STATUS_INVALID_PARAMETER

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

STATUS_NOT_FOUND

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

STATUS_NOT_SUPPORTED

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

其他

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

言论

GetUnicastIpAddressEntry 函数通常用于检索要修改的现有 MIB_UNICASTIPADDRESS_ROW 结构条目。 然后,驱动程序可以更改要修改的 MIB_UNICASTIPADDRESS_ROW 条目中的成员,然后调用 SetUnicastIpAddressEntry 函数。

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

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

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

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

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

要求

目标平台

通用

版本

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

页眉

Netioapi.h (包括 Netioapi.h)

图书馆

Netio.lib

IRQL

< DISPATCH_LEVEL

另请参阅

CreateUnicastIpAddressEntry

DeleteUnicastIpAddressEntry

GetUnicastIpAddressTable

InitializeUnicastIpAddressEntry

MIB_UNICASTIPADDRESS_ROW

MIB_UNICASTIPADDRESS_TABLE

NotifyUnicastIpAddressChange

SetUnicastIpAddressEntry