Win32 API 日本語リファレンス
ホームNetworkManagement.IpHelper › DeleteIpForwardEntry2

DeleteIpForwardEntry2

関数
IPルーティングテーブルから経路エントリを削除する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// IPHLPAPI.dll
#include <windows.h>

WIN32_ERROR DeleteIpForwardEntry2(
    const MIB_IPFORWARD_ROW2* Row
);

パラメーター

名前方向説明
RowMIB_IPFORWARD_ROW2*inIP ルートエントリの MIB_IPFORWARD_ROW2 構造体エントリへのポインター。正常に復帰すると、このエントリは削除されます。

戻り値の型: WIN32_ERROR

公式ドキュメント

ローカルコンピューター上の IP ルートエントリを削除します。

戻り値

関数が成功した場合、戻り値は NO_ERROR です。

関数が失敗した場合、戻り値は次のいずれかのエラーコードです。

戻りコード 説明
ERROR_ACCESS_DENIED
アクセスが拒否されました。このエラーは、次を含むいくつかの条件で返されます。すなわち、ユーザーがローカルコンピューターで必要な管理者権限を持っていない場合、またはアプリケーションが組み込みの Administrator(管理者として実行)として昇格されたシェルで実行されていない場合です。
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。このエラーは、Row パラメーターに NULL ポインターが渡された場合、Row パラメーターが指す MIB_IPFORWARD_ROW2DestinationPrefix メンバーが指定されていなかった場合、Row パラメーターが指す MIB_IPFORWARD_ROW2NextHop メンバーが指定されていなかった場合、または Row パラメーターが指す MIB_IPFORWARD_ROW2InterfaceLuidInterfaceIndex の両メンバーが指定されていなかった場合に返されます。
ERROR_NOT_FOUND
指定されたインターフェイスが見つかりませんでした。このエラーは、Row パラメーターが指す MIB_IPFORWARD_ROW2InterfaceLuid または InterfaceIndex メンバーで指定されたネットワークインターフェイスが見つからなかった場合に返されます。
ERROR_NOT_SUPPORTED
要求がサポートされていません。このエラーは、ローカルコンピューターに IPv4 スタックが存在しないにもかかわらず、Row パラメーターが指す MIB_IPFORWARD_ROW2Address メンバーに IPv4 アドレスが指定された場合に返されます。また、ローカルコンピューターに IPv6 スタックが存在しないにもかかわらず、Address メンバーに IPv6 アドレスが指定された場合にも返されます。
その他
返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

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 構造体の次のメンバーのうち少なくとも 1 つを初期化しておく必要があります。すなわち、InterfaceLuid または InterfaceIndex です。

これらのフィールドは、上記に列挙した順序で使用されます。したがって、InterfaceLuid が指定されている場合は、このメンバーを使用してインターフェイスが決定されます。InterfaceLuid メンバーに値が設定されていない場合(このメンバーの値が 0 に設定されている場合)は、次に InterfaceIndex メンバーを使用してインターフェイスが決定されます。

呼び出しが成功した場合の出力時には、DeleteIpForwardEntry2 は IP ルートエントリを削除します。

DeleteIpForwardEntry2 関数は、Row パラメーターが指す MIB_IPFORWARD_ROW2DestinationPrefix および NextHop メンバーが、InterfaceLuid または InterfaceIndex メンバーで指定されたインターフェイス上の既存の IP ルートエントリと一致しない場合に失敗します。

GetIpForwardTable2 関数を呼び出すと、ローカルコンピューター上の IP ルートエントリを列挙できます。

DeleteIpForwardEntry2 関数は、Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出せます。Administrators グループのメンバーでないユーザーが DeleteIpForwardEntry2 を呼び出した場合、関数呼び出しは失敗し、ERROR_ACCESS_DENIED が返されます。この関数は、Windows Vista 以降ではユーザーアカウント制御(UAC)が原因で失敗することもあります。この関数を含むアプリケーションが、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーによって実行された場合、マニフェストファイルでアプリケーションに requestedExecutionLevel が requireAdministrator に設定されてマークされていない限り、この呼び出しは失敗します。アプリケーションにこのマニフェストファイルがない場合、この関数を成功させるには、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーは、組み込みの Administrator(管理者として実行)として昇格されたシェルでアプリケーションを実行する必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// IPHLPAPI.dll
#include <windows.h>

WIN32_ERROR DeleteIpForwardEntry2(
    const MIB_IPFORWARD_ROW2* Row
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint DeleteIpForwardEntry2(
    IntPtr Row   // MIB_IPFORWARD_ROW2*
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function DeleteIpForwardEntry2(
    Row As IntPtr   ' MIB_IPFORWARD_ROW2*
) As UInteger
End Function
' Row : MIB_IPFORWARD_ROW2*
Declare PtrSafe Function DeleteIpForwardEntry2 Lib "iphlpapi" ( _
    ByVal Row As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DeleteIpForwardEntry2 = ctypes.windll.iphlpapi.DeleteIpForwardEntry2
DeleteIpForwardEntry2.restype = wintypes.DWORD
DeleteIpForwardEntry2.argtypes = [
    ctypes.c_void_p,  # Row : MIB_IPFORWARD_ROW2*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
DeleteIpForwardEntry2 = Fiddle::Function.new(
  lib['DeleteIpForwardEntry2'],
  [
    Fiddle::TYPE_VOIDP,  # Row : MIB_IPFORWARD_ROW2*
  ],
  -Fiddle::TYPE_INT)
#[link(name = "iphlpapi")]
extern "system" {
    fn DeleteIpForwardEntry2(
        Row: *const MIB_IPFORWARD_ROW2  // MIB_IPFORWARD_ROW2*
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint DeleteIpForwardEntry2(IntPtr Row);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_DeleteIpForwardEntry2' -Namespace Win32 -PassThru
# $api::DeleteIpForwardEntry2(Row)
#uselib "IPHLPAPI.dll"
#func global DeleteIpForwardEntry2 "DeleteIpForwardEntry2" sptr
; DeleteIpForwardEntry2 varptr(Row)   ; 戻り値は stat
; Row : MIB_IPFORWARD_ROW2* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "IPHLPAPI.dll"
#cfunc global DeleteIpForwardEntry2 "DeleteIpForwardEntry2" var
; res = DeleteIpForwardEntry2(Row)
; Row : MIB_IPFORWARD_ROW2* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; WIN32_ERROR DeleteIpForwardEntry2(MIB_IPFORWARD_ROW2* Row)
#uselib "IPHLPAPI.dll"
#cfunc global DeleteIpForwardEntry2 "DeleteIpForwardEntry2" var
; res = DeleteIpForwardEntry2(Row)
; Row : MIB_IPFORWARD_ROW2* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procDeleteIpForwardEntry2 = iphlpapi.NewProc("DeleteIpForwardEntry2")
)

// Row (MIB_IPFORWARD_ROW2*)
r1, _, err := procDeleteIpForwardEntry2.Call(
	uintptr(Row),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function DeleteIpForwardEntry2(
  Row: Pointer   // MIB_IPFORWARD_ROW2*
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'DeleteIpForwardEntry2';
result := DllCall("IPHLPAPI\DeleteIpForwardEntry2"
    , "Ptr", Row   ; MIB_IPFORWARD_ROW2*
    , "UInt")   ; return: WIN32_ERROR
●DeleteIpForwardEntry2(Row) = DLL("IPHLPAPI.dll", "dword DeleteIpForwardEntry2(void*)")
# 呼び出し: DeleteIpForwardEntry2(Row)
# Row : MIB_IPFORWARD_ROW2* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "iphlpapi" fn DeleteIpForwardEntry2(
    Row: [*c]MIB_IPFORWARD_ROW2 // MIB_IPFORWARD_ROW2*
) callconv(std.os.windows.WINAPI) u32;
proc DeleteIpForwardEntry2(
    Row: ptr MIB_IPFORWARD_ROW2  # MIB_IPFORWARD_ROW2*
): uint32 {.importc: "DeleteIpForwardEntry2", stdcall, dynlib: "IPHLPAPI.dll".}
pragma(lib, "iphlpapi");
extern(Windows)
uint DeleteIpForwardEntry2(
    MIB_IPFORWARD_ROW2* Row   // MIB_IPFORWARD_ROW2*
);
ccall((:DeleteIpForwardEntry2, "IPHLPAPI.dll"), stdcall, UInt32,
      (Ptr{MIB_IPFORWARD_ROW2},),
      Row)
# Row : MIB_IPFORWARD_ROW2* -> Ptr{MIB_IPFORWARD_ROW2}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t DeleteIpForwardEntry2(
    void* Row);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.DeleteIpForwardEntry2(Row)
-- Row : MIB_IPFORWARD_ROW2*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const DeleteIpForwardEntry2 = lib.func('__stdcall', 'DeleteIpForwardEntry2', 'uint32_t', ['void *']);
// DeleteIpForwardEntry2(Row)
// Row : MIB_IPFORWARD_ROW2* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IPHLPAPI.dll", {
  DeleteIpForwardEntry2: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.DeleteIpForwardEntry2(Row)
// Row : MIB_IPFORWARD_ROW2* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t DeleteIpForwardEntry2(
    void* Row);
C, "IPHLPAPI.dll");
// $ffi->DeleteIpForwardEntry2(Row);
// Row : MIB_IPFORWARD_ROW2*
// 構造体/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 DeleteIpForwardEntry2(
        Pointer Row   // MIB_IPFORWARD_ROW2*
    );
}
@[Link("iphlpapi")]
lib LibIPHLPAPI
  fun DeleteIpForwardEntry2 = DeleteIpForwardEntry2(
    Row : MIB_IPFORWARD_ROW2*   # MIB_IPFORWARD_ROW2*
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DeleteIpForwardEntry2Native = Uint32 Function(Pointer<Void>);
typedef DeleteIpForwardEntry2Dart = int Function(Pointer<Void>);
final DeleteIpForwardEntry2 = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<DeleteIpForwardEntry2Native, DeleteIpForwardEntry2Dart>('DeleteIpForwardEntry2');
// Row : MIB_IPFORWARD_ROW2* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DeleteIpForwardEntry2(
  Row: Pointer   // MIB_IPFORWARD_ROW2*
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'DeleteIpForwardEntry2';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DeleteIpForwardEntry2"
  c_DeleteIpForwardEntry2 :: Ptr () -> IO Word32
-- Row : MIB_IPFORWARD_ROW2* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let deleteipforwardentry2 =
  foreign "DeleteIpForwardEntry2"
    ((ptr void) @-> returning uint32_t)
(* Row : MIB_IPFORWARD_ROW2* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("DeleteIpForwardEntry2" delete-ip-forward-entry2 :convention :stdcall) :uint32
  (row :pointer))   ; MIB_IPFORWARD_ROW2*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DeleteIpForwardEntry2 = Win32::API::More->new('IPHLPAPI',
    'DWORD DeleteIpForwardEntry2(LPVOID Row)');
# my $ret = $DeleteIpForwardEntry2->Call($Row);
# Row : MIB_IPFORWARD_ROW2* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目
使用する型