getIpPathEntry 函数 (netioapi.h)

GetIpPathEntry 函数检索本地计算机上的 IP 路径条目的信息。

语法

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpPathEntry(
  [in, out] PMIB_IPPATH_ROW Row
);

参数

[in, out] Row

指向 IP 路径条目 MIB_IPPATH_ROW 结构条目的指针。 成功返回后，将使用 IP 路径条目的属性更新此结构。

返回值

如果函数成功，则返回值NO_ERROR。

如果函数失败，则返回值为以下错误代码之一。

返回代码	说明
ERROR_FILE_NOT_FOUND	系统找不到指定的文件。 如果由 Row 参数指向的MIB_IPPATH_ROW的 InterfaceLuid 或 InterfaceIndex 成员指定的网络接口 LUID 或接口索引不是本地计算机上的值，则返回此错误。
ERROR_INVALID_PARAMETER	参数不正确。 如果在 Row 参数中传递 NULL 指针，Row 参数指向的MIB_IPPATH_ROW的 Destination 成员中的si_family成员未设置为 AF_INET 或 AF_INET6，或者未指定 Row 参数指向的MIB_IPPATH_ROW的 InterfaceLuid 或 InterfaceIndex 成员，则返回此错误。 如果 Row 参数指向MIB_IPPATH_ROW的 Source 成员中的si_family成员与目标 IP 地址系列不匹配，并且源 IP 地址si_family未指定为AF_UNSPEC，则也会返回此错误。
ERROR_NOT_FOUND	找不到元素。 如果由 Row 参数指向的 MIB_IPPATH_ROW 结构的 InterfaceLuid 或 InterfaceIndex 成员指定的网络接口与 MIB_IPPATH_ROW 结构中 Destination 成员中指定的 IP 地址和地址系列不匹配，则返回此错误。
ERROR_NOT_SUPPORTED	不支持该请求。 如果本地计算机上没有 IPv4 堆栈，并且 Row 参数指向的MIB_IPPATH_ROW的 Source 和 Destination 成员中指定了 IPv4 地址，则返回此错误。 如果本地计算机上没有 IPv6 堆栈，并且 源 成员和 目标 成员中指定了 IPv6 地址，也会返回此错误。
其他	使用 FormatMessage 获取返回错误的消息字符串。

注解

GetIpPathEntry 函数在 Windows Vista 及更高版本上定义。

GetIpPathEntry 函数用于检索MIB_IPPATH_ROW结构条目。

输入时，Row 参数指向的 MIB_IPPATH_ROW 结构中的 Destination 成员必须初始化为有效的 IPv4 或 IPv6 地址和系列。 MIB_IPPATH_ROW结构中的源成员中指定的地址系列还必须与目标成员中指定的目标 IP 地址系列匹配，或者源成员中的地址系列必须指定为AF_UNSPEC。 此外，必须初始化指向 Row 参数的 MIB_IPPATH_ROW 结构中的至少一个成员：InterfaceLuid 或 InterfaceIndex。

字段按上面列出的顺序使用。 因此，如果指定了 InterfaceLuid ，则使用此成员来确定接口。 如果没有为 InterfaceLuid 成员设置值 (此成员的值设置为零) ，则接下来使用 InterfaceIndex 成员来确定接口。

在调用成功时输出时，GetIpPathEntry 检索 IP 路径条目的其他属性，并填充 Row 参数指向的MIB_IPPATH_ROW结构。

可以调用 GetIpPathTable 函数来枚举本地计算机上的 IP 路径条目。

要求

要求	值
最低受支持的客户端	Windows Vista [仅限桌面应用]
最低受支持的服务器	Windows Server 2008 [仅限桌面应用]
目标平台	Windows
标头	netioapi.h (包括 Iphlpapi.h)
Library	Iphlpapi.lib
DLL	Iphlpapi.dll

另请参阅

FlushIpPathTable

GetIpPathTable

MIB_IPPATH_ROW

MIB_IPPATH_TABLE