GetIpForwardEntry2 函式
GetIpForwardEntry2 函式會擷取本機電腦上的 IP 路由項目資訊。
語法
NETIOAPI_API GetIpForwardEntry2(
_Inout_ PMIB_IPFORWARD_ROW2 Row
);
參數
-
列 [in， out]
IP 路由專案的 MIB_IPFORWARD_ROW2 結構專案的指標。 成功傳回時，會使用IP路由專案的屬性來更新此結構。
傳回值
如果函式成功，GetIpForwardEntry2 會傳回STATUS_SUCCESS。
如果函式失敗，GetIpForwardEntry2 會傳回下列其中一個錯誤碼：
| 傳回碼 | 描述 |
|---|---|
| STATUS_INVALID_PARAMETER | 無效的參數已傳遞至函式。 如果發生下列其中一種情況，就會傳回此錯誤：
|
| STATUS_NOT_FOUND | 找不到指定的介面。 如果函式找不到由 InterfaceLuid 或 InterfaceIndex MIB_IPFORWARD_ROW2 結構成員所指定的網路介面，Row 參數所指向，就會傳回此錯誤。 |
| STATUS_NOT_SUPPORTED | 不支援要求。 如果本機計算機上沒有 IPv4 堆棧，且AF_INET是在 DestinationPrefix MIB_IPFORWARD_ROW2 結構的成員中指定，Row 參數所指向的位址系列中，或如果本機計算機上沒有 IPv6 堆棧，且AF_INET6指定給 DestinationPrefix 成員中的位址系列，則會傳回此錯誤。 |
| 其他 | 使用 FormatMessage 函式取得傳回錯誤的訊息字串。 |
言論
GetIpForwardEntry2 函式可用來擷取 MIB_IPFORWARD_ROW2 結構專案。
在輸入時，驅動程式必須初始化 Row 參數所指向之MIB_IPFORWARD_ROW2結構的下列成員。
DestinationPrefix
設定為有效的 IPv4 或 IPv6 位址前綴和系列。NextHop
設定為有效的 IPv4 或 IPv6 位址和系列。InterfaceLuid 或 InterfaceIndex
這些成員會依照稍早所列的順序使用。 因此，如果指定 InterfaceLuid，則會使用此成員來判斷介面。 如果未為 InterfaceLuid 成員設定任何值（此成員的值設定為零），則 InterfaceIndex 成員會接著用來判斷介面。
在輸出中，當呼叫成功時，GetIpForwardEntry2 擷取IP路由專案的其他屬性，並填入 Row 參數指向的MIB_IPFORWARD_ROW2結構。
Metric 中所指定的路由計量位移 MIB_IPFORWARD_ROW2 結構的成員，Row 參數只代表完整路由計量的一部分。 完整計量是新增至介面計量的路由計量的組合，該計量是在關聯介面MIB_IPINTERFACE_ROW結構 計量 成員中指定的。 驅動程式可以藉由呼叫 getIpInterfaceEntry函式來擷取介面計量。
您的驅動程式可以呼叫 GetIpForwardTable2 函式，以列舉本機電腦上的 IP 路由專案。
要求
目標平臺 |
通用 |
版本 |
可在 Windows Vista 和更新版本的 Windows作系統中使用。 |
頁眉 |
Netioapi.h （包括 Netioapi.h） |
圖書館 |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |