DeleteIpForwardEntry
関数シグネチャ
// IPHLPAPI.dll
#include <windows.h>
DWORD DeleteIpForwardEntry(
MIB_IPFORWARDROW* pRoute
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pRoute | MIB_IPFORWARDROW* | in | MIB_IPFORWARDROW 構造体へのポインターです。この構造体には、削除するルートを識別する情報を指定します。呼び出し元は、構造体の dwForwardIfIndex、dwForwardDest、dwForwardMask、dwForwardNextHop、dwForwardProto の各メンバーに値を指定する必要があります。 |
戻り値の型: DWORD
公式ドキュメント
ローカルコンピューターの IPv4 ルーティングテーブルにある既存のルートを削除します。
戻り値
処理が成功した場合、この関数は NO_ERROR(ゼロ)を返します。
関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。
| エラーコード | 意味 |
|---|---|
| アクセスが拒否されました。このエラーは、Windows Vista および Windows Server 2008 において、次のような複数の条件下で返されます。すなわち、ユーザーがローカルコンピューターで必要な管理者権限を持っていない場合、またはアプリケーションが組み込みの Administrator として昇格したシェルで実行されていない(管理者として実行されていない)場合などです。 | |
| 入力パラメーターが無効であり、何の処理も行われませんでした。このエラーは、pRoute パラメーターが NULL である場合、PMIB_IPFORWARDROW 構造体の dwForwardMask メンバーが有効な IPv4 サブネットマスクでない場合、dwForwardIfIndex メンバーが NULL である場合、または MIB_IPFORWARDROW 構造体の他のメンバーのいずれかが無効である場合に返されます。 | |
| pRoute パラメーターが、存在しないルートエントリを指しています。 | |
| ローカルコンピューターで IPv4 トランスポートが構成されていません。 | |
|
この関数は、その他のエラーコードを返す場合があります。 |
関数が失敗した場合は、 FormatMessage を使用して、返されたエラーのメッセージ文字列を取得してください。
解説(Remarks)
route パラメーターが指す MIB_IPFORWARDROW 構造体の dwForwardProto メンバーには MIB_IPPROTO_NETMGMT を設定する必要があります。そうでない場合、DeleteIpForwardEntry は失敗します。ルーティングプロトコル識別子は、指定したルーティングプロトコルのルート情報を識別するために使用されます。たとえば MIB_IPPROTO_NETMGMT は、Dynamic Host Configuration Protocol (DHCP)、Simple Network Management Protocol (SNMP) などのネットワーク管理を通じて設定された IP ルーティングのルート情報、または CreateIpForwardEntry、DeleteIpForwardEntry 、SetIpForwardEntry の各関数の呼び出しによって設定されたルート情報を識別するために使用されます。
Windows Vista および Windows Server 2008 では、DeleteIpForwardEntry は、サブインターフェイスを 1 つだけ持つインターフェイス(インターフェイス LUID とサブインターフェイス LUID が同じであるもの)に対してのみ機能します。MIB_IPFORWARDROW 構造体の dwForwardIfIndex メンバーがインターフェイスを指定します。
route パラメーターが指す MIB_IPFORWARDROW 構造体のメンバーの一部は、現在 CreateIpForwardEntry では使用されていません。これらのメンバーには、dwForwardPolicy、dwForwardType、dwForwardAge、dwForwardNextHopAS、dwForwardMetric1、dwForwardMetric2、dwForwardMetric3、dwForwardMetric4、dwForwardMetric5 が含まれます。
IPv4 ルーティングテーブル内の既存のルートを変更するには、 SetIpForwardEntry 関数を使用します。IPv4 ルーティングテーブルを取得するには、GetIpForwardTable 関数を呼び出します。
Windows Vista 以降では、DeleteIpForwardEntry 関数は、Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出すことができます。DeleteIpForwardEntry が Administrators グループのメンバーではないユーザーによって呼び出された場合、この関数呼び出しは失敗し、ERROR_ACCESS_DENIED が返されます。
DeleteIpForwardEntry 関数は、Windows Vista 以降ではユーザーアカウント制御 (UAC) によって失敗することもあります。この関数を含むアプリケーションが、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーによって実行された場合、マニフェストファイルで requestedExecutionLevel が requireAdministrator に設定されていない限り、この呼び出しは失敗します。アプリケーションにこのマニフェストファイルがない場合、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーは、この関数を成功させるために、組み込みの Administrator として昇格したシェル(管理者として実行)でアプリケーションを実行する必要があります。
例
次のコード例は、既定のゲートウェイを NewGateway に変更する方法を示しています。GetIpForwardTable を呼び出してゲートウェイを変更し、その後 SetIpForwardEntry を呼び出しても、ルートは変更されず、新しいルートが追加されます。既定のゲートウェイが複数存在する場合、このコードはそれらを削除します。新しいゲートウェイは到達可能である必要がある点に注意してください。そうでない場合、TCP/IP はこの変更を無視します。
#ifndef WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN
#endif
#include <windows.h>
#include <winsock2.h>
#include <iphlpapi.h>
#include <stdio.h>
#include <stdlib.h>
#pragma comment(lib, "iphlpapi.lib")
int main()
{
// Declare and initialize variables
PMIB_IPFORWARDTABLE pIpForwardTable = NULL;
PMIB_IPFORWARDROW pRow = NULL;
DWORD dwSize = 0;
BOOL bOrder = FALSE;
DWORD dwStatus = 0;
DWORD NewGateway = 0xDDBBCCAA; // this is in host order Ip Address AA.BB.CC.DD is DDCCBBAA
unsigned int i;
// Identify the required size of the buffer.
dwStatus = GetIpForwardTable(pIpForwardTable, &dwSize, bOrder);
if (dwStatus == ERROR_INSUFFICIENT_BUFFER) {
// Allocate memory for the table.
if (!(pIpForwardTable = (PMIB_IPFORWARDTABLE) malloc(dwSize))) {
printf("Malloc failed. Out of memory.\n");
exit(1);
}
// Retrieve the table.
dwStatus = GetIpForwardTable(pIpForwardTable, &dwSize, bOrder);
}
if (dwStatus != ERROR_SUCCESS) {
printf("getIpForwardTable failed.\n");
if (pIpForwardTable)
free(pIpForwardTable);
exit(1);
}
// Search for the required row in the table. The default gateway has a destination
// of 0.0.0.0. Be aware the table continues to be searched, but only
// one row is copied. This is to ensure that, if multiple gateways exist, all of them are deleted.
//
for (i = 0; i < pIpForwardTable->dwNumEntries; i++) {
if (pIpForwardTable->table[i].dwForwardDest == 0) {
// The default gateway was found.
if (!pRow) {
// Allocate memory to store the row. This is easier than manually filling
// the row structure; only the gateway address is changed.
//
pRow = (PMIB_IPFORWARDROW) malloc(sizeof (MIB_IPFORWARDROW));
if (!pRow) {
printf("Malloc failed. Out of memory.\n");
exit(1);
}
// Copy the row.
memcpy(pRow, &(pIpForwardTable->table[i]),
sizeof (MIB_IPFORWARDROW));
}
// Delete the old default gateway entry.
dwStatus = DeleteIpForwardEntry(&(pIpForwardTable->table[i]));
if (dwStatus != ERROR_SUCCESS) {
printf("Could not delete old gateway\n");
exit(1);
}
}
}
// Set the nexthop field to our new gateway. All other properties of the route will
// remain the same.
pRow->dwForwardNextHop = NewGateway;
// Create a new route entry for the default gateway.
dwStatus = CreateIpForwardEntry(pRow);
if (dwStatus == NO_ERROR)
printf("Gateway changed successfully\n");
else if (dwStatus == ERROR_INVALID_PARAMETER)
printf("Invalid parameter.\n");
else
printf("Error: %d\n", dwStatus);
// Free the memory.
if (pIpForwardTable)
free(pIpForwardTable);
if (pRow)
free(pRow);
exit(0);
}
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// IPHLPAPI.dll
#include <windows.h>
DWORD DeleteIpForwardEntry(
MIB_IPFORWARDROW* pRoute
);[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint DeleteIpForwardEntry(
IntPtr pRoute // MIB_IPFORWARDROW*
);<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function DeleteIpForwardEntry(
pRoute As IntPtr ' MIB_IPFORWARDROW*
) As UInteger
End Function' pRoute : MIB_IPFORWARDROW*
Declare PtrSafe Function DeleteIpForwardEntry Lib "iphlpapi" ( _
ByVal pRoute As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
DeleteIpForwardEntry = ctypes.windll.iphlpapi.DeleteIpForwardEntry
DeleteIpForwardEntry.restype = wintypes.DWORD
DeleteIpForwardEntry.argtypes = [
ctypes.c_void_p, # pRoute : MIB_IPFORWARDROW*
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('IPHLPAPI.dll')
DeleteIpForwardEntry = Fiddle::Function.new(
lib['DeleteIpForwardEntry'],
[
Fiddle::TYPE_VOIDP, # pRoute : MIB_IPFORWARDROW*
],
-Fiddle::TYPE_INT)#[link(name = "iphlpapi")]
extern "system" {
fn DeleteIpForwardEntry(
pRoute: *mut MIB_IPFORWARDROW // MIB_IPFORWARDROW*
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint DeleteIpForwardEntry(IntPtr pRoute);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_DeleteIpForwardEntry' -Namespace Win32 -PassThru
# $api::DeleteIpForwardEntry(pRoute)#uselib "IPHLPAPI.dll"
#func global DeleteIpForwardEntry "DeleteIpForwardEntry" sptr
; DeleteIpForwardEntry varptr(pRoute) ; 戻り値は stat
; pRoute : MIB_IPFORWARDROW* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "IPHLPAPI.dll" #cfunc global DeleteIpForwardEntry "DeleteIpForwardEntry" var ; res = DeleteIpForwardEntry(pRoute) ; pRoute : MIB_IPFORWARDROW* -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll" #cfunc global DeleteIpForwardEntry "DeleteIpForwardEntry" sptr ; res = DeleteIpForwardEntry(varptr(pRoute)) ; pRoute : MIB_IPFORWARDROW* -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; DWORD DeleteIpForwardEntry(MIB_IPFORWARDROW* pRoute) #uselib "IPHLPAPI.dll" #cfunc global DeleteIpForwardEntry "DeleteIpForwardEntry" var ; res = DeleteIpForwardEntry(pRoute) ; pRoute : MIB_IPFORWARDROW* -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD DeleteIpForwardEntry(MIB_IPFORWARDROW* pRoute) #uselib "IPHLPAPI.dll" #cfunc global DeleteIpForwardEntry "DeleteIpForwardEntry" intptr ; res = DeleteIpForwardEntry(varptr(pRoute)) ; pRoute : MIB_IPFORWARDROW* -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
procDeleteIpForwardEntry = iphlpapi.NewProc("DeleteIpForwardEntry")
)
// pRoute (MIB_IPFORWARDROW*)
r1, _, err := procDeleteIpForwardEntry.Call(
uintptr(pRoute),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction DeleteIpForwardEntry(
pRoute: Pointer // MIB_IPFORWARDROW*
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'DeleteIpForwardEntry';result := DllCall("IPHLPAPI\DeleteIpForwardEntry"
, "Ptr", pRoute ; MIB_IPFORWARDROW*
, "UInt") ; return: DWORD●DeleteIpForwardEntry(pRoute) = DLL("IPHLPAPI.dll", "dword DeleteIpForwardEntry(void*)")
# 呼び出し: DeleteIpForwardEntry(pRoute)
# pRoute : MIB_IPFORWARDROW* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "iphlpapi" fn DeleteIpForwardEntry(
pRoute: [*c]MIB_IPFORWARDROW // MIB_IPFORWARDROW*
) callconv(std.os.windows.WINAPI) u32;proc DeleteIpForwardEntry(
pRoute: ptr MIB_IPFORWARDROW # MIB_IPFORWARDROW*
): uint32 {.importc: "DeleteIpForwardEntry", stdcall, dynlib: "IPHLPAPI.dll".}pragma(lib, "iphlpapi");
extern(Windows)
uint DeleteIpForwardEntry(
MIB_IPFORWARDROW* pRoute // MIB_IPFORWARDROW*
);ccall((:DeleteIpForwardEntry, "IPHLPAPI.dll"), stdcall, UInt32,
(Ptr{MIB_IPFORWARDROW},),
pRoute)
# pRoute : MIB_IPFORWARDROW* -> Ptr{MIB_IPFORWARDROW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t DeleteIpForwardEntry(
void* pRoute);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.DeleteIpForwardEntry(pRoute)
-- pRoute : MIB_IPFORWARDROW*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const DeleteIpForwardEntry = lib.func('__stdcall', 'DeleteIpForwardEntry', 'uint32_t', ['void *']);
// DeleteIpForwardEntry(pRoute)
// pRoute : MIB_IPFORWARDROW* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("IPHLPAPI.dll", {
DeleteIpForwardEntry: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.DeleteIpForwardEntry(pRoute)
// pRoute : MIB_IPFORWARDROW* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t DeleteIpForwardEntry(
void* pRoute);
C, "IPHLPAPI.dll");
// $ffi->DeleteIpForwardEntry(pRoute);
// pRoute : MIB_IPFORWARDROW*
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Iphlpapi extends StdCallLibrary {
Iphlpapi INSTANCE = Native.load("iphlpapi", Iphlpapi.class);
int DeleteIpForwardEntry(
Pointer pRoute // MIB_IPFORWARDROW*
);
}@[Link("iphlpapi")]
lib LibIPHLPAPI
fun DeleteIpForwardEntry = DeleteIpForwardEntry(
pRoute : MIB_IPFORWARDROW* # MIB_IPFORWARDROW*
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef DeleteIpForwardEntryNative = Uint32 Function(Pointer<Void>);
typedef DeleteIpForwardEntryDart = int Function(Pointer<Void>);
final DeleteIpForwardEntry = DynamicLibrary.open('IPHLPAPI.dll')
.lookupFunction<DeleteIpForwardEntryNative, DeleteIpForwardEntryDart>('DeleteIpForwardEntry');
// pRoute : MIB_IPFORWARDROW* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function DeleteIpForwardEntry(
pRoute: Pointer // MIB_IPFORWARDROW*
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'DeleteIpForwardEntry';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "DeleteIpForwardEntry"
c_DeleteIpForwardEntry :: Ptr () -> IO Word32
-- pRoute : MIB_IPFORWARDROW* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let deleteipforwardentry =
foreign "DeleteIpForwardEntry"
((ptr void) @-> returning uint32_t)
(* pRoute : MIB_IPFORWARDROW* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)
(cffi:defcfun ("DeleteIpForwardEntry" delete-ip-forward-entry :convention :stdcall) :uint32
(p-route :pointer)) ; MIB_IPFORWARDROW*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $DeleteIpForwardEntry = Win32::API::More->new('IPHLPAPI',
'DWORD DeleteIpForwardEntry(LPVOID pRoute)');
# my $ret = $DeleteIpForwardEntry->Call($pRoute);
# pRoute : MIB_IPFORWARDROW* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f DeleteIpForwardEntry2 — IPルーティングテーブルから経路エントリを削除する。
- f CreateIpForwardEntry — IPv4ルーティングテーブルに新しい経路エントリを追加する。
- f GetIpForwardTable — IPv4のルーティングテーブル(経路情報)を取得する。
- f SetIpForwardEntry — IPv4ルーティングテーブルの既存経路エントリを変更する。