GetIpForwardTable2 函数
GetIpForwardTable2 函数检索本地计算机上的 IP 路由条目。
语法
NETIOAPI_API GetIpForwardTable2(
_In_ ADDRESS_FAMILY Family,
_Out_ PMIB_IPFORWARD_TABLE2 *Table
);
参数
家庭 [in]
要检索的地址系列。Winsock2.h 头文件中列出了地址系列的可能值。 请注意，AF_地址系列和PF_协议系列常量的值 (相同，例如，AF_INET和PF_INET) ，因此可以使用任一常量。
在 Windows Vista 和更高版本的 Windows 操作系统上， Family 参数的可能值在 Ws2def.h 头文件中定义。 请注意，Ws2def.h 头文件自动包含在 Netioapi.h 中，你不应直接使用 Ws2def.h。
地址系列当前支持以下值：
AF_INET
IPv4 地址系列。 指定此值后，此函数返回仅包含 IPv4 条目的 IP 路由表。AF_INET6
IPv6 地址系列。 指定此值后，此函数返回仅包含 IPv6 条目的 IP 路由表。AF_UNSPEC
未指定地址系列。 指定此值后，此函数将返回同时包含 IPv4 和 IPv6 条目的 IP 路由表。
表 [out]
指向 MIB_IPFORWARD_TABLE2 结构的指针，该结构包含本地计算机上的 IP 路由条目表。
返回值
如果函数成功，GetIpForwardTable2 将返回STATUS_SUCCESS。
如果函数失败， GetIpForwardTable2 将返回以下错误代码之一：
| 返回代码 | 说明 |
|---|---|
| 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 函数获取返回错误的消息字符串。 |
注解
GetIpForwardTable2 函数枚举本地计算机上的 IP 路由条目，并在MIB_IPFORWARD_TABLE2结构中返回此信息。
IP 路由条目在 Table 参数指向的缓冲区中的 MIB_IPFORWARD_TABLE2 结构中返回。 MIB_IPFORWARD_TABLE2结构包含每个 IP 路由条目的 IP 路由条目计数和 MIB_IPFORWARD_ROW2 结构数组。 当不再需要这些返回的结构时，驱动程序应通过调用 FreeMibTable 释放内存。
驱动程序必须将 Family 参数初始化为AF_INET、AF_INET6或AF_UNSPEC。
请注意， Table 参数指向的返回MIB_IPFORWARD_TABLE2结构可能包含 NumEntries 成员与 MIB_IPFORWARD_TABLE2 结构的 Table 成员中的第一个MIB_IPFORWARD_ROW2数组条目之间的对齐填充。 MIB_IPFORWARD_ROW2数组条目之间也可能存在对齐填充。 对MIB_IPFORWARD_ROW2数组条目的任何访问都应假定可能存在填充。
要求
目标平台 |
通用 |
版本 |
在 Windows Vista 和更高版本的 Windows 操作系统中可用。 |
标头 |
Netioapi.h (包括 Netioapi.h) |
库 |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |