GetIpInterfaceTable 函数

GetIpInterfaceTable 函数检索本地计算机上的 IP 接口条目。

语法

NETIOAPI_API GetIpInterfaceTable(
  _In_  ADDRESS_FAMILY         Family,
  _Out_ PMIB_IPINTERFACE_TABLE *Table
);

参数

  • 家庭 [in]
    要检索的 IP 接口的地址系列。

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

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

    地址系列当前支持以下值:

    • AF_INET
      IPv4 地址系列。

    • AF_INET6
      IPv6 地址系列。

    • AF_UNSPEC
      未指定地址系列。 指定此值后,GetIpInterfaceTable 函数返回包含 IPv4 和 IPv6 条目的 IP 接口表。

  • [out]
    指向接收 MIB_IPINTERFACE_TABLE 结构中 IP 接口条目表的缓冲区的指针。

返回值

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

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

返回代码 描述
STATUS_INVALID_PARAMETER

将无效参数传递给函数。 如果在表 参数中传递了 NULL 指针,或者未将Family 参数指定为AF_INET、AF_INET6或AF_UNSPEC,则返回此错误。

STATUS_NOT_ENOUGH_MEMORY

内存资源不足,无法完成作。

STATUS_NOT_FOUND

找不到 Family 参数中指定的 IP 接口条目。

STATUS_NOT_SUPPORTED

不支持该函数。 如果未在本地计算机上配置 地址 参数中指定的 IP 传输,则返回此错误。 在不支持此函数的 Windows 版本上也返回此错误。

其他

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

言论

GetIpInterfaceTable 函数枚举本地计算机上的 IP 接口,并在 MIB_IPINTERFACE_TABLE 结构中返回此信息。

GetIpInterfaceTable 返回缓冲区中 参数指向的MIB_IPINTERFACE_TABLE结构中的 IP 接口条目。 MIB_IPINTERFACE_TABLE结构包含 IP 接口条目计数和每个 IP 接口条目 MIB_IPINTERFACE_ROW 结构的数组。 不再需要这些返回的结构时,驱动程序应通过调用 FreeMibTable 函数来释放内存。

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

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

要求

目标平台

通用

版本

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

页眉

Netioapi.h (包括 Netioapi.h)

图书馆

Netio.lib

IRQL

< DISPATCH_LEVEL

另请参阅

FreeMibTable

MIB_IPINTERFACE_ROW

MIB_IPINTERFACE_TABLE

MIB_IPNET_ROW2

MIB_IPNET_TABLE2