GetUnicastIpAddressTable 函数

项目
06/15/2023

GetUnicastIpAddressTable 函数检索本地计算机上的单播 IP 地址表。

语法

NETIOAPI_API GetUnicastIpAddressTable(
  _In_  ADDRESS_FAMILY              Family,
  _Out_ PMIB_UNICASTIPADDRESS_TABLE *Table
);

参数

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

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

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

地址系列当前支持以下值：
- AF_INET
  IPv4 地址系列。指定此值时，此函数返回仅包含 IPv4 条目的多播 IP 地址表。
- AF_INET6
  IPv6 地址系列。指定此值时，此函数返回仅包含 IPv6 条目的多播 IP 地址表。
- AF_UNSPEC
  地址系列未指定。指定此值后，此函数返回同时包含 IPv4 和 IPv6 条目的多播 IP 地址表。
表 [out]
指向 MIB_UNICASTIPADDRESS_TABLE 结构的指针，该结构包含本地计算机上的单播 IP 地址条目表。

返回值

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

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

返回代码	说明
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 函数获取返回错误的消息字符串。

注解

GetUnicastIpAddressTable 函数枚举本地计算机上的单播 IP 地址，并在MIB_UNICASTIPADDRESS_TABLE结构中返回此信息。

GetUnicastIpAddressTable 返回 Table 参数指向的缓冲区中MIB_UNICASTIPADDRESS_TABLE结构中的单播 IP 地址条目。 MIB_UNICASTIPADDRESS_TABLE 结构包含单播 IP 地址条目计数和每个单播 IP 地址条目 的MIB_UNICASTIPADDRESS_ROW 结构数组。当不再需要这些返回的结构时，驱动程序应通过调用 FreeMibTable 释放内存。

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

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

要求

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