FlushIpNetTable2
関数シグネチャ
// IPHLPAPI.dll
#include <windows.h>
WIN32_ERROR FlushIpNetTable2(
ADDRESS_FAMILY Family,
DWORD InterfaceIndex
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Family | ADDRESS_FAMILY | in | フラッシュするアドレス ファミリ。 アドレス ファミリに指定できる値は、Winsock2.h ヘッダー ファイルに一覧されています。AF_ アドレス ファミリ定数と PF_ プロトコル ファミリ定数の値は同一である(たとえば AF_INET と PF_INET)ため、どちらの定数も使用できます。 Windows Vista 以降向けにリリースされた Windows SDK では、ヘッダー ファイルの構成が変更され、このメンバーに指定できる値は Ws2def.h ヘッダー ファイルで定義されています。なお、Ws2def.h ヘッダー ファイルは Winsock2.h に自動的にインクルードされるため、直接使用しないでください。 現在サポートされている値は AF_INET、AF_INET6、AF_UNSPEC です。
| ||||||||
| InterfaceIndex | DWORD | in | インターフェイス インデックス。インデックスを指定すると、特定のインターフェイス上の近隣 IP アドレス エントリをフラッシュします。指定しない場合は、すべてのインターフェイス上の近隣 IP アドレス エントリをフラッシュします。インターフェイスを無視するには、このパラメーターを 0 に設定します。 |
戻り値の型: WIN32_ERROR
公式ドキュメント
FlushIpNetTable2 関数は、ローカル コンピューター上の IP 近隣テーブルをフラッシュします。
戻り値
関数が成功した場合、戻り値は NO_ERROR です。
関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。
| 戻り値 | 説明 |
|---|---|
| アクセスが拒否されました。このエラーは、次のようないくつかの条件下で返されます。ユーザーがローカル コンピューター上で必要な管理者権限を持っていない場合、またはアプリケーションが組み込み Administrator として昇格されたシェル(管理者として実行)で実行されていない場合です。 | |
| 無効なパラメーターが関数に渡されました。このエラーは、Family パラメーターに AF_INET、AF_INET6、または AF_UNSPEC が指定されていない場合に返されます。 | |
| 要求はサポートされていません。このエラーは、ローカル コンピューターに IPv4 スタックが存在せず、Family パラメーターに AF_INET が指定された場合に返されます。また、ローカル コンピューターに IPv6 スタックが存在せず、Family パラメーターに AF_INET6 が指定された場合にも返されます。さらに、この関数がサポートされていないバージョンの Windows でも返されます。 | |
|
FormatMessage を使用して、返されたエラーのメッセージ文字列を取得してください。 |
解説(Remarks)
FlushIpNetTable2 関数は Windows Vista 以降で定義されています。
FlushIpNetTable2 関数は、ローカル システム上の近隣 IP アドレスをフラッシュまたは削除します。Family パラメーターを使用すると、削除する近隣 IP アドレスを特定の IP アドレス ファミリに限定できます。IPv4 と IPv6 の両方の近隣 IP アドレスを削除する場合は、Family パラメーターを AF_UNSPEC に設定します。InterfaceIndex パラメーターを使用すると、削除する近隣 IP アドレスを特定のインターフェイスに限定できます。すべてのインターフェイスの近隣 IP アドレスを削除する場合は、InterfaceIndex パラメーターを 0 に設定します。
Family パラメーターは、AF_INET、AF_INET6、または AF_UNSPEC のいずれかで初期化する必要があります。
FlushIpNetTable2 関数は、Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出せます。Administrators グループのメンバーではないユーザーが FlushIpNetTable2 を呼び出した場合、関数呼び出しは失敗し、ERROR_ACCESS_DENIED が返されます。この関数は、Windows Vista 以降のユーザー アカウント制御 (UAC) が原因で失敗することもあります。この関数を含むアプリケーションが、組み込み Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーによって実行された場合、マニフェスト ファイルで requestedExecutionLevel が requireAdministrator に設定されていない限り、この呼び出しは失敗します。アプリケーションにこのマニフェスト ファイルがない場合、組み込み Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーは、この関数を成功させるために、組み込み Administrator として昇格されたシェル(管理者として実行)でアプリケーションを実行する必要があります。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// IPHLPAPI.dll
#include <windows.h>
WIN32_ERROR FlushIpNetTable2(
ADDRESS_FAMILY Family,
DWORD InterfaceIndex
);[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint FlushIpNetTable2(
ushort Family, // ADDRESS_FAMILY
uint InterfaceIndex // DWORD
);<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function FlushIpNetTable2(
Family As UShort, ' ADDRESS_FAMILY
InterfaceIndex As UInteger ' DWORD
) As UInteger
End Function' Family : ADDRESS_FAMILY
' InterfaceIndex : DWORD
Declare PtrSafe Function FlushIpNetTable2 Lib "iphlpapi" ( _
ByVal Family As Integer, _
ByVal InterfaceIndex As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
FlushIpNetTable2 = ctypes.windll.iphlpapi.FlushIpNetTable2
FlushIpNetTable2.restype = wintypes.DWORD
FlushIpNetTable2.argtypes = [
ctypes.c_ushort, # Family : ADDRESS_FAMILY
wintypes.DWORD, # InterfaceIndex : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('IPHLPAPI.dll')
FlushIpNetTable2 = Fiddle::Function.new(
lib['FlushIpNetTable2'],
[
-Fiddle::TYPE_SHORT, # Family : ADDRESS_FAMILY
-Fiddle::TYPE_INT, # InterfaceIndex : DWORD
],
-Fiddle::TYPE_INT)#[link(name = "iphlpapi")]
extern "system" {
fn FlushIpNetTable2(
Family: u16, // ADDRESS_FAMILY
InterfaceIndex: u32 // DWORD
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint FlushIpNetTable2(ushort Family, uint InterfaceIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_FlushIpNetTable2' -Namespace Win32 -PassThru
# $api::FlushIpNetTable2(Family, InterfaceIndex)#uselib "IPHLPAPI.dll"
#func global FlushIpNetTable2 "FlushIpNetTable2" sptr, sptr
; FlushIpNetTable2 Family, InterfaceIndex ; 戻り値は stat
; Family : ADDRESS_FAMILY -> "sptr"
; InterfaceIndex : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "IPHLPAPI.dll"
#cfunc global FlushIpNetTable2 "FlushIpNetTable2" int, int
; res = FlushIpNetTable2(Family, InterfaceIndex)
; Family : ADDRESS_FAMILY -> "int"
; InterfaceIndex : DWORD -> "int"; WIN32_ERROR FlushIpNetTable2(ADDRESS_FAMILY Family, DWORD InterfaceIndex)
#uselib "IPHLPAPI.dll"
#cfunc global FlushIpNetTable2 "FlushIpNetTable2" int, int
; res = FlushIpNetTable2(Family, InterfaceIndex)
; Family : ADDRESS_FAMILY -> "int"
; InterfaceIndex : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
procFlushIpNetTable2 = iphlpapi.NewProc("FlushIpNetTable2")
)
// Family (ADDRESS_FAMILY), InterfaceIndex (DWORD)
r1, _, err := procFlushIpNetTable2.Call(
uintptr(Family),
uintptr(InterfaceIndex),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WIN32_ERRORfunction FlushIpNetTable2(
Family: Word; // ADDRESS_FAMILY
InterfaceIndex: DWORD // DWORD
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'FlushIpNetTable2';result := DllCall("IPHLPAPI\FlushIpNetTable2"
, "UShort", Family ; ADDRESS_FAMILY
, "UInt", InterfaceIndex ; DWORD
, "UInt") ; return: WIN32_ERROR●FlushIpNetTable2(Family, InterfaceIndex) = DLL("IPHLPAPI.dll", "dword FlushIpNetTable2(int, dword)")
# 呼び出し: FlushIpNetTable2(Family, InterfaceIndex)
# Family : ADDRESS_FAMILY -> "int"
# InterfaceIndex : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "iphlpapi" fn FlushIpNetTable2(
Family: u16, // ADDRESS_FAMILY
InterfaceIndex: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;proc FlushIpNetTable2(
Family: uint16, # ADDRESS_FAMILY
InterfaceIndex: uint32 # DWORD
): uint32 {.importc: "FlushIpNetTable2", stdcall, dynlib: "IPHLPAPI.dll".}pragma(lib, "iphlpapi");
extern(Windows)
uint FlushIpNetTable2(
ushort Family, // ADDRESS_FAMILY
uint InterfaceIndex // DWORD
);ccall((:FlushIpNetTable2, "IPHLPAPI.dll"), stdcall, UInt32,
(UInt16, UInt32),
Family, InterfaceIndex)
# Family : ADDRESS_FAMILY -> UInt16
# InterfaceIndex : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t FlushIpNetTable2(
uint16_t Family,
uint32_t InterfaceIndex);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.FlushIpNetTable2(Family, InterfaceIndex)
-- Family : ADDRESS_FAMILY
-- InterfaceIndex : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const FlushIpNetTable2 = lib.func('__stdcall', 'FlushIpNetTable2', 'uint32_t', ['uint16_t', 'uint32_t']);
// FlushIpNetTable2(Family, InterfaceIndex)
// Family : ADDRESS_FAMILY -> 'uint16_t'
// InterfaceIndex : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("IPHLPAPI.dll", {
FlushIpNetTable2: { parameters: ["u16", "u32"], result: "u32" },
});
// lib.symbols.FlushIpNetTable2(Family, InterfaceIndex)
// Family : ADDRESS_FAMILY -> "u16"
// InterfaceIndex : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t FlushIpNetTable2(
uint16_t Family,
uint32_t InterfaceIndex);
C, "IPHLPAPI.dll");
// $ffi->FlushIpNetTable2(Family, InterfaceIndex);
// Family : ADDRESS_FAMILY
// InterfaceIndex : DWORD
// 構造体/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 FlushIpNetTable2(
short Family, // ADDRESS_FAMILY
int InterfaceIndex // DWORD
);
}@[Link("iphlpapi")]
lib LibIPHLPAPI
fun FlushIpNetTable2 = FlushIpNetTable2(
Family : UInt16, # ADDRESS_FAMILY
InterfaceIndex : UInt32 # DWORD
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef FlushIpNetTable2Native = Uint32 Function(Uint16, Uint32);
typedef FlushIpNetTable2Dart = int Function(int, int);
final FlushIpNetTable2 = DynamicLibrary.open('IPHLPAPI.dll')
.lookupFunction<FlushIpNetTable2Native, FlushIpNetTable2Dart>('FlushIpNetTable2');
// Family : ADDRESS_FAMILY -> Uint16
// InterfaceIndex : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function FlushIpNetTable2(
Family: Word; // ADDRESS_FAMILY
InterfaceIndex: DWORD // DWORD
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'FlushIpNetTable2';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "FlushIpNetTable2"
c_FlushIpNetTable2 :: Word16 -> Word32 -> IO Word32
-- Family : ADDRESS_FAMILY -> Word16
-- InterfaceIndex : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let flushipnettable2 =
foreign "FlushIpNetTable2"
(uint16_t @-> uint32_t @-> returning uint32_t)
(* Family : ADDRESS_FAMILY -> uint16_t *)
(* InterfaceIndex : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)
(cffi:defcfun ("FlushIpNetTable2" flush-ip-net-table2 :convention :stdcall) :uint32
(family :uint16) ; ADDRESS_FAMILY
(interface-index :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $FlushIpNetTable2 = Win32::API::More->new('IPHLPAPI',
'DWORD FlushIpNetTable2(WORD Family, DWORD InterfaceIndex)');
# my $ret = $FlushIpNetTable2->Call($Family, $InterfaceIndex);
# Family : ADDRESS_FAMILY -> WORD
# InterfaceIndex : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f FlushIpNetTable — 指定インターフェイスのARPテーブルをすべて消去する。
- f CreateIpNetEntry2 — 近隣テーブルに新しいIPと物理アドレスの対応を追加する。
- f DeleteIpNetEntry2 — 近隣テーブルから指定エントリを削除する。
- f GetIpNetEntry2 — 指定した近隣(IP-物理アドレス)エントリの情報を取得する。
- f GetIpNetTable2 — 指定アドレスファミリの近隣(ARP/NDP)テーブルを取得する。
- s MIB_IPNET_ROW2
- s MIB_IPNET_TABLE2
- f ResolveIpNetEntry2 — 指定IPアドレスの物理アドレスを解決し近隣エントリに格納する。
- f SetIpNetEntry2 — 指定した近隣(IP-物理アドレス)エントリを設定する。