DeleteIpForwardEntry2 函式
DeleteIpForwardEntry2函式會刪除本機電腦上的 IP 路由專案。
語法
NETIOAPI_API DeleteIpForwardEntry2(
_In_ const MIB_IPFORWARD_ROW2 *Row
);
參數
- 資料列 [in]
IP 路由專案的 MIB_IPFORWARD_ROW2 結構專案的指標。 成功傳回時,會刪除此專案。
傳回值
如果函式成功,DeleteIpForwardEntry2會傳回STATUS_SUCCESS。
如果函式失敗, DeleteIpForwardEntry2 會傳回下列其中一個錯誤碼:
傳回碼 | 描述 |
---|---|
STATUS_INVALID_PARAMETER | 不正確參數已傳遞至 函式。 如果在Row參數中傳遞Null指標、未指定Row參數所指向之MIB_IPFORWARD_ROW2結構的DestinationPrefix成員、未指定MIB_IPFORWARD_ROW2結構的NextHop成員,或未指定 MIB_IPFORWARD_ROW2 結構的InterfaceLuid和InterfaceIndex成員,則會傳回此錯誤。 |
STATUS_NOT_FOUND | 找不到指定的介面。 如果函式找不到Row參數指向之MIB_IPFORWARD_ROW2結構的InterfaceLuid或InterfaceIndex成員所指定的網路介面,就會傳回此錯誤。 |
STATUS_NOT_SUPPORTED | 不支援此要求。 如果本機電腦上沒有 IPv4 堆疊,而且在Row參數所指向之 MIB_IPFORWARD_ROW2 結構的Address成員中指定了 IPv4 位址,或如果本機電腦上沒有 IPv6 堆疊,且位址成員中指定了 IPv6 位址,則會傳回此錯誤。 |
其他 | 使用 FormatMessage 函式來取得傳回錯誤的訊息字串。 |
備註
DeleteIpForwardEntry2函式可用來刪除MIB_IPFORWARD_ROW2結構專案。
在輸入時,驅動程式必須初始化 Row 參數指向的下列MIB_IPFORWARD_ROW2結構成員。
DestinationPrefix
設定為有效的 IPv4 或 IPv6 位址首碼和系列。NextHop
設定為有效的 IPv4 或 IPv6 位址和系列。InterfaceLuid 或 InterfaceIndex
這些成員會依照稍早所列的順序使用。 因此,如果指定 InterfaceLuid ,則會使用此成員來判斷介面。 如果未為 InterfaceLuid 成員設定任何值, (這個成員的值設定為零) ,則接著會使用 InterfaceIndex 成員來判斷介面。
在輸出中,當呼叫成功時, DeleteIpForwardEntry2 會刪除 IP 路由專案。
如果Row參數指向之 MIB_IPFORWARD_ROW2 結構的DestinationPrefix和NextHop成員不符合InterfaceLuid或InterfaceIndex成員中指定的介面上現有的 IP 路由專案,DeleteIpForwardEntry2函式就會失敗。
您的驅動程式可以呼叫 GetIpForwardTable2 函式,以列舉本機電腦上的 IP 路由專案。
規格需求
目標平台 |
普遍 |
版本 |
可在 Windows Vista 和更新版本的 Windows 作業系統中使用。 |
標頭 |
Netioapi.h (包含 Netioapi.h) |
程式庫 |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |