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 指针，Row参数指向的 MIB_UNICASTIPADDRESS_ROW 结构的 Address 成员未设置为有效的单播 IPv4 或 IPv6 地址，或者未指定 MIB_UNICASTIPADDRESS_ROW 结构的 InterfaceLuid 和 InterfaceIndex 成员，则返回此错误。 |
| STATUS_NOT_FOUND | 找不到指定的接口。 如果函数找不到由 Row 参数指向的 MIB_UNICASTIPADDRESS_ROW 结构的 InterfaceLuid 或 InterfaceIndex 成员指定的网络接口，则返回此错误。 |
| STATUS_NOT_SUPPORTED | 不支持该请求。 如果本地计算机上没有 IPv4 堆栈，并且行参数指向的 MIB_UNICASTIPADDRESS_ROW 结构的 Address 成员中指定了 IPv4 地址，或者如果本地计算机上没有 IPv6 堆栈，并且地址成员中指定了 IPv6 地址，则返回此错误。 |
| 其他 | 使用 FormatMessage 函数获取返回错误的消息字符串。 |
注解
GetUnicastIpAddressEntry 函数通常用于检索要修改的现有MIB_UNICASTIPADDRESS_ROW结构条目。 然后，驱动程序可以更改要修改 的 MIB_UNICASTIPADDRESS_ROW 条目中的成员，然后调用 SetUnicastIpAddressEntry 函数。
输入时，驱动程序必须初始化 Row 参数指向的 MIB_UNICASTIPADDRESS_ROW 结构的以下成员。
Address
设置为有效的单播 IPv4 或 IPv6 地址和系列。InterfaceLuid 或 InterfaceIndex
这些成员按前面列出的顺序使用。 因此，如果指定 了 InterfaceLuid ，则使用此成员来确定接口。 如果没有为 InterfaceLuid 成员设置值， (此成员的值已设置为零) ，则接下来将使用 InterfaceIndex 成员来确定接口。
在输出中，当调用成功时，GetUnicastIpAddressEntry 将检索单播 IP 地址的其他属性，并填充 Row 参数指向的MIB_UNICASTIPADDRESS_ROW结构。
驱动程序可以调用 GetUnicastIpAddressTable 函数来枚举本地计算机上的单播 IP 地址条目。
要求
目标平台 |
通用 |
版本 |
在 Windows Vista 和更高版本的 Windows 操作系统中可用。 |
标头 |
Netioapi.h (包括 Netioapi.h) |
库 |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |