deleteIpForwardEntry2 函式 (netioapi.h)
DeleteIpForwardEntry2 函式會刪除本機電腦上的IP路由專案。
語法
IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API DeleteIpForwardEntry2(
[in] const MIB_IPFORWARD_ROW2 *Row
);
參數
[in] Row
IP 路由專案的 MIB_IPFORWARD_ROW2 結構專案的指標。 成功傳回時,將會刪除此專案。
傳回值
如果函式成功,傳回值會NO_ERROR。
如果函式失敗,傳回值就是下列其中一個錯誤碼。
傳回碼 | Description |
---|---|
|
存取遭到拒絕。 此錯誤會在下列幾個情況下傳回:使用者缺少本機計算機上的必要系統管理許可權,或應用程式未在增強的殼層中執行,因為 RunAs 系統管理員) 內建系統管理員 (。 |
|
無效的參數已傳遞至 函式。 如果未指定 Row 參數所指向之MIB_IPFORWARD_ROW2的 DestinationPrefix 成員、未指定 Row 參數所指向之 MIB_IPFORWARD_ROW2 MIB_IPFORWARD_ROW2的 NextHop 成員,或未指定 Row 參數所指向的 InterfaceLuid 或 InterfaceIndex 成員,則會傳回此錯誤參數未指定。 |
|
找不到指定的介面。 如果找不到 Row 參數所指向MIB_IPFORWARD_ROW2之 InterfaceLuid 或 InterfaceIndex 成員所指定的網路介面,就會傳回此錯誤。 |
|
不支援此要求。 如果本機計算機上沒有IPv4堆棧,而且在Row參數所指向之MIB_IPFORWARD_ROW2的Address成員中指定了IPv4位址,就會傳回此錯誤。 如果本機計算機上沒有IPv6堆棧,而且已在 Address 成員中指定IPv6位址,也會傳回此錯誤。 |
|
使用 FormatMessage 取得傳回錯誤的訊息字串。 |
備註
DeleteIpForwardEntry2 函式是在 Windows Vista 和更新版本上定義。
DeleteIpForwardEntry2 函式可用來刪除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 成員來判斷介面。
呼叫成功時輸出時, DeleteIpForwardEntry2 會刪除IP路由專案。
如果 Row 參數所指向之MIB_IPFORWARD_ROW2的 DestinationPrefix 和 NextHop 成員不符合 InterfaceLuid 或 InterfaceIndex 成員中指定的介面上現有的 IP 路由專案,DeleteIpForwardEntry2 函式將會失敗。
您可以呼叫 GetIpForwardTable2 函式來列舉本機電腦上的 IP 路由專案。
DeleteIpForwardEntry2 函式只能由以 Administrators 群組成員身分登入的使用者呼叫。 如果 DeleteIpForwardEntry2 是由不是 Administrators 群組成員的使用者呼叫,則函數調用將會失敗,並 傳回ERROR_ACCESS_DENIED 。 此函式也可能因為 Windows Vista 和更新版本的用戶帳戶控制 (UAC) 而失敗。 如果包含此函式的應用程式是由以內建系統管理員以外的 Administrators 群組成員身分登入的使用者所執行,除非應用程式已在指令清單檔案中標示 為 requestedExecutionLevel 設定為 requireAdministrator,否則此呼叫將會失敗。 如果應用程式缺少此指令清單檔,則以系統管理員以外的 Administrators 群組成員身分登入的使用者,必須在增強的殼層中執行應用程式,因為內建的 Administrator (RunAs 系統管理員) ,此函式才能成功。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2008 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | netioapi.h (包含 Iphlpapi.h) |
程式庫 | Iphlpapi.lib |
Dll | Iphlpapi.dll |