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。

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

傳回碼	Description
ERROR_FILE_NOT_FOUND	系統找不到指定的檔案。 如果 Row 參數所指向MIB_IPPATH_ROW之 InterfaceLuid 或 InterfaceIndex 成員所指定的網路介面 LUID 或介面索引不是本機電腦上的值，就會傳回此錯誤。
ERROR_INVALID_PARAMETER	參數不正確。 如果在 Row 參數中傳遞 NULL 指標，則不會將 Row 參數所指向之MIB_IPPATH_ROW目的地成員中的si_family成員設定為AF_INET或AF_INET6，或是未指定 Row 參數所指向之MIB_IPPATH_ROW的 InterfaceLuid 或 InterfaceIndex 成員，就會傳回此錯誤。 如果 Row 參數所指向 MIB_IPPATH_ROW之來源成員中的si_family成員不符合目的地 IP 位址系列，而且來源 IP 位址的si_family未指定為AF_UNSPEC，也會傳回此錯誤。
ERROR_NOT_FOUND	Element not found. 如果 Row 參數所指向之 MIB_IPPATH_ROW 結構的 InterfaceLuid 或 InterfaceIndex 成員所指定的網路介面不符合 MIB_IPPATH_ROW 結構中目的地成員中指定的 IP 位址和位址系列，就會傳回此錯誤。
ERROR_NOT_SUPPORTED	不支援此要求。 如果在本機計算機上沒有IPv4堆棧，而且在Row參數所指向之MIB_IPPATH_ROW的來源和目的地成員中指定IPv4位址，則會傳回此錯誤。 如果本機計算機上沒有IPv6堆棧，而且 來源 和 目的地 成員中指定了IPv6位址，也會傳回此錯誤。
其他	使用 FormatMessage 取得傳回錯誤的訊息字串。

備註

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

GetIpPathEntry 函式可用來擷取MIB_IPPATH_ROW結構專案。

在輸入時，Row 參數所指向之MIB_IPPATH_ROW結構的 Destination 成員必須初始化為有效的 IPv4 或 IPv6 位址和系列。 MIB_IPPATH_ROW結構中Source成員中指定的位址系列也必須符合目的地成員中指定的目的地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)
程式庫	Iphlpapi.lib
Dll	Iphlpapi.dll

另請參閱

FlushIpPathTable

GetIpPathTable

MIB_IPPATH_ROW

MIB_IPPATH_TABLE