GetIpPathEntry 函式
GetIpPathEntry 函式會擷取本機電腦上的 IP 路徑項目資訊。
語法
NETIOAPI_API GetIpPathEntry(
_Inout_ PMIB_IPPATH_ROW Row
);
參數
-
列 [in， out]
IP 路徑專案之 MIB_IPPATH_ROW 結構專案的指標。 成功傳回時，會使用IP路徑專案的屬性來更新此結構。
傳回值
如果函式成功，GetIpPathEntry 會傳回STATUS_SUCCESS。
如果函式失敗，GetIpPathEntry 會傳回下列其中一個錯誤碼：
| 傳回碼 | 描述 |
|---|---|
| STATUS_INVALID_PARAMETER | 無效的參數已傳遞至函式。 如果在 Row 參數中傳遞 NULL 指標，則會傳回此錯誤，Destination 成員 MIB_IPPATH_ROW 結構 Row 參數指向的 si_family 成員未設定為 AF_INET 或 AF_INET6， 或兩者 InterfaceLuid 和 InterfaceIndex 未指定MIB_IPPATH_ROW結構的成員。 如果MIB_IPPATH_ROW結構 來源 成員中的 si_family 成員不符合目的地 IP 位址系列，且來源 IP 位址的 si_family 未指定為AF_UNSPEC，也會傳回此錯誤。 |
| STATUS_NOT_FOUND | 找不到指定的介面。 如果函式找不到 InterfaceLuid 或 InterfaceIn dex 所指定的網路介面，則會傳回此錯誤，MIB_IPPATH_ROW結構的成員 Row 參數所指向。 |
| STATUS_NOT_SUPPORTED | 不支援要求。 如果本機電腦上沒有 IPv4 堆疊，且在 Source 和 Destination 中指定了 IPv4 位址，則會傳回此錯誤MIB_IPPATH_ROW結構的成員，Row 參數所指向的 MIB_IPPATH_ROW 結構成員， 如果本機電腦上沒有 IPv6 堆棧，且在 來源 和 目的地 成員中指定了 IPv6 位址，則為 。 |
| 其他 | 使用 FormatMessage 函式取得傳回錯誤的訊息字串。 |
言論
GetIpPathEntry 函式可用來擷取 MIB_IPPATH_ROW 結構專案。
在輸入時，驅動程式必須初始化 Row 參數所指向之MIB_IPPATH_ROW結構的下列成員。
目的地
設定為有效的 IPv4 或 IPv6 位址和系列。來源
將 Source 成員中指定的位址系列設定為 目的地 成員中指定的目的地 IP 位址系列，或設定為 AF_UNSPEC。InterfaceLuid 或 InterfaceIndex
這些成員會依照稍早所列的順序使用。 因此，如果指定 InterfaceLuid，則會使用此成員來判斷介面。 如果未為 InterfaceLuid 成員設定任何值（此成員的值設定為零），則 InterfaceIndex 成員會接著用來判斷介面。
在輸出中，當呼叫成功時，GetIpPathEntry 擷取IP路徑專案的其他屬性，並填入 Row 參數指向的MIB_IPPATH_ROW結構。
您的驅動程式可以呼叫 GetIpPathTable 函式，以列舉本機電腦上的 IP 路徑專案。
要求
目標平臺 |
通用 |
版本 |
可在 Windows Vista 和更新版本的 Windows作系統中使用。 |
頁眉 |
Netioapi.h （包括 Netioapi.h） |
圖書館 |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |