getIpForwardEntry2 函式 (netioapi.h)

發行項
02/29/2024

GetIpForwardEntry2 函式會擷取本機電腦上的IP路由項目資訊。

語法

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpForwardEntry2(
  [in, out] PMIB_IPFORWARD_ROW2 Row
);

參數

[in, out] Row

IP 路由專案的 MIB_IPFORWARD_ROW2 結構專案的指標。成功傳回時，將會使用IP路由專案的屬性來更新此結構。

傳回值

如果函式成功，傳回值會NO_ERROR。

如果函式失敗，傳回值就是下列其中一個錯誤碼。

傳回碼	Description
ERROR_INVALID_PARAMETER	無效的參數已傳遞至函式。如果未指定 Row 參數所指向之MIB_IPFORWARD_ROW2的 DestinationPrefix 成員、未指定 Row 參數所指向之 MIB_IPFORWARD_ROW2 MIB_IPFORWARD_ROW2的 NextHop 成員，或未指定 Row 參數所指向的 InterfaceLuid 或 InterfaceIndex 成員，則會傳回此錯誤參數未指定。
ERROR_NOT_FOUND	Element not found. 如果 Row 參數所指向之 MIB_IPFORWARD_ROW2 結構的 InterfaceLuid 或 InterfaceIndex 成員所指定的網路介面不符合 MIB_IPFORWARD_ROW2 結構之 DestinationPrefix 成員中指定的 IP 位址前綴和位址系列，就會傳回此錯誤。
ERROR_NOT_SUPPORTED	不支援此要求。如果本機計算機上沒有IPv4堆棧，而且在Row參數所指向之 MIB_IPFORWARD_ROW2DestinationPrefix 成員的位址系列中指定了AF_INET，就會傳回此錯誤。如果本機計算機上沒有IPv6堆棧，而且已為 DestinationPrefix 成員中的位址系列指定AF_INET6，也會傳回此錯誤。
其他	使用 FormatMessage 取得傳回錯誤的訊息字串。

備註

GetIpForwardEntry2 函式是在 Windows Vista 和更新版本上定義。

GetIpForwardEntry2 函式可用來擷取MIB_IPFORWARD_ROW2結構專案。

在輸入時，Row 參數所指向之MIB_IPFORWARD_ROW2結構中的 DestinationPrefix 成員必須初始化為有效的 IPv4 或 IPv6 位址前綴和系列。在輸入時，Row 參數所指向之MIB_IPFORWARD_ROW2結構中的 NextHop 成員必須初始化為有效的 IPv4 或 IPv6 位址和系列。此外，至少必須初始化指向 Row 參數之MIB_IPFORWARD_ROW2結構中的下列其中一個成員：InterfaceLuid 或 InterfaceIndex。

欄位會依照上面所列的順序使用。因此，如果指定 InterfaceLuid ，則會使用此成員來判斷介面。如果未為 InterfaceLuid 成員設定任何值， (此成員的值設定為零) ，則接著會使用 InterfaceIndex 成員來判斷介面。

在呼叫成功時輸出時，GetIpForwardEntry2 會擷取IP路由專案的其他屬性，並填入Row參數所指向的MIB_IPFORWARD_ROW2結構。

Row 參數所指向之MIB_IPFORWARD_ROW2結構的 Metric 成員中指定的路由計量位移，僅代表完整路由計量的一部分。完整計量是這個路由計量的組合，此路由計量會新增至相關聯介面之MIB_IPINTERFACE_ROW結構之計量成員中指定的介面計量。應用程式可以藉由呼叫 GetIpInterfaceEntry 函式來擷取介面計量。

您可以呼叫 GetIpForwardTable2 函式來列舉本機電腦上的 IP 路由專案。

規格需求

需求	值
最低支援的用戶端	Windows Vista [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2008 [僅限傳統型應用程式]
目標平台	Windows
標頭	netioapi.h (包含 Iphlpapi.h)
程式庫	Iphlpapi.lib
Dll	Iphlpapi.dll