FlushIpNetTable
関数シグネチャ
// IPHLPAPI.dll
#include <windows.h>
DWORD FlushIpNetTable(
DWORD dwIfIndex
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| dwIfIndex | DWORD | in | すべての ARP エントリを削除する対象インターフェイスのインデックス。 |
戻り値の型: DWORD
公式ドキュメント
FlushIpNetTable 関数は、指定されたインターフェイスのすべての ARP エントリを、ローカルコンピューター上の ARP テーブルから削除します。
戻り値
関数が成功した場合、NO_ERROR(ゼロ)を返します。
関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。
| 戻り値 | 説明 |
|---|---|
| アクセスが拒否されました。このエラーは Windows Vista および Windows Server 2008 で、次のような複数の状況において返されます。すなわち、ユーザーがローカルコンピューター上で必要な管理者権限を持っていない場合、またはアプリケーションが組み込みの Administrator(管理者として実行)による昇格されたシェルで実行されていない場合などです。 | |
| 入力パラメーターが無効であり、処理は行われませんでした。このエラーは dwIfIndex パラメーターが無効な場合に返されます。 | |
| ローカルコンピューターで IPv4 トランスポートが構成されていません。 | |
|
返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用します。 |
解説(Remarks)
ARP テーブルを取得するには、GetIpNetTable 関数を呼び出します。
Windows Vista 以降では、FlushIpNetTable 関数は Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出せます。Administrators グループのメンバーでないユーザーが FlushIpNetTable を呼び出した場合、関数呼び出しは失敗し、ERROR_ACCESS_DENIED が返されます。この関数は、Windows Vista 以降のユーザーアカウント制御(UAC)が原因で失敗することもあります。この関数を含むアプリケーションが、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーによって実行された場合、マニフェストファイルで requestedExecutionLevel が requireAdministrator に設定されていない限り、この呼び出しは失敗します。Windows Vista 以降でアプリケーションにこのマニフェストファイルが存在しない場合、この関数を成功させるには、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーが、組み込みの Administrator(管理者として実行)による昇格されたシェルでアプリケーションを実行する必要があります。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// IPHLPAPI.dll
#include <windows.h>
DWORD FlushIpNetTable(
DWORD dwIfIndex
);[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint FlushIpNetTable(
uint dwIfIndex // DWORD
);<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function FlushIpNetTable(
dwIfIndex As UInteger ' DWORD
) As UInteger
End Function' dwIfIndex : DWORD
Declare PtrSafe Function FlushIpNetTable Lib "iphlpapi" ( _
ByVal dwIfIndex As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
FlushIpNetTable = ctypes.windll.iphlpapi.FlushIpNetTable
FlushIpNetTable.restype = wintypes.DWORD
FlushIpNetTable.argtypes = [
wintypes.DWORD, # dwIfIndex : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('IPHLPAPI.dll')
FlushIpNetTable = Fiddle::Function.new(
lib['FlushIpNetTable'],
[
-Fiddle::TYPE_INT, # dwIfIndex : DWORD
],
-Fiddle::TYPE_INT)#[link(name = "iphlpapi")]
extern "system" {
fn FlushIpNetTable(
dwIfIndex: u32 // DWORD
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint FlushIpNetTable(uint dwIfIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_FlushIpNetTable' -Namespace Win32 -PassThru
# $api::FlushIpNetTable(dwIfIndex)#uselib "IPHLPAPI.dll"
#func global FlushIpNetTable "FlushIpNetTable" sptr
; FlushIpNetTable dwIfIndex ; 戻り値は stat
; dwIfIndex : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "IPHLPAPI.dll"
#cfunc global FlushIpNetTable "FlushIpNetTable" int
; res = FlushIpNetTable(dwIfIndex)
; dwIfIndex : DWORD -> "int"; DWORD FlushIpNetTable(DWORD dwIfIndex)
#uselib "IPHLPAPI.dll"
#cfunc global FlushIpNetTable "FlushIpNetTable" int
; res = FlushIpNetTable(dwIfIndex)
; dwIfIndex : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
procFlushIpNetTable = iphlpapi.NewProc("FlushIpNetTable")
)
// dwIfIndex (DWORD)
r1, _, err := procFlushIpNetTable.Call(
uintptr(dwIfIndex),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction FlushIpNetTable(
dwIfIndex: DWORD // DWORD
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'FlushIpNetTable';result := DllCall("IPHLPAPI\FlushIpNetTable"
, "UInt", dwIfIndex ; DWORD
, "UInt") ; return: DWORD●FlushIpNetTable(dwIfIndex) = DLL("IPHLPAPI.dll", "dword FlushIpNetTable(dword)")
# 呼び出し: FlushIpNetTable(dwIfIndex)
# dwIfIndex : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "iphlpapi" fn FlushIpNetTable(
dwIfIndex: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;proc FlushIpNetTable(
dwIfIndex: uint32 # DWORD
): uint32 {.importc: "FlushIpNetTable", stdcall, dynlib: "IPHLPAPI.dll".}pragma(lib, "iphlpapi");
extern(Windows)
uint FlushIpNetTable(
uint dwIfIndex // DWORD
);ccall((:FlushIpNetTable, "IPHLPAPI.dll"), stdcall, UInt32,
(UInt32,),
dwIfIndex)
# dwIfIndex : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t FlushIpNetTable(
uint32_t dwIfIndex);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.FlushIpNetTable(dwIfIndex)
-- dwIfIndex : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const FlushIpNetTable = lib.func('__stdcall', 'FlushIpNetTable', 'uint32_t', ['uint32_t']);
// FlushIpNetTable(dwIfIndex)
// dwIfIndex : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("IPHLPAPI.dll", {
FlushIpNetTable: { parameters: ["u32"], result: "u32" },
});
// lib.symbols.FlushIpNetTable(dwIfIndex)
// dwIfIndex : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t FlushIpNetTable(
uint32_t dwIfIndex);
C, "IPHLPAPI.dll");
// $ffi->FlushIpNetTable(dwIfIndex);
// dwIfIndex : 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 FlushIpNetTable(
int dwIfIndex // DWORD
);
}@[Link("iphlpapi")]
lib LibIPHLPAPI
fun FlushIpNetTable = FlushIpNetTable(
dwIfIndex : 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 FlushIpNetTableNative = Uint32 Function(Uint32);
typedef FlushIpNetTableDart = int Function(int);
final FlushIpNetTable = DynamicLibrary.open('IPHLPAPI.dll')
.lookupFunction<FlushIpNetTableNative, FlushIpNetTableDart>('FlushIpNetTable');
// dwIfIndex : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function FlushIpNetTable(
dwIfIndex: DWORD // DWORD
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'FlushIpNetTable';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "FlushIpNetTable"
c_FlushIpNetTable :: Word32 -> IO Word32
-- dwIfIndex : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let flushipnettable =
foreign "FlushIpNetTable"
(uint32_t @-> returning uint32_t)
(* dwIfIndex : 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 ("FlushIpNetTable" flush-ip-net-table :convention :stdcall) :uint32
(dw-if-index :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $FlushIpNetTable = Win32::API::More->new('IPHLPAPI',
'DWORD FlushIpNetTable(DWORD dwIfIndex)');
# my $ret = $FlushIpNetTable->Call($dwIfIndex);
# dwIfIndex : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f FlushIpNetTable2 — 指定アドレスファミリ・インターフェイスの近隣テーブルを消去する。
- f CreateIpNetEntry — ARPテーブルに新しいIPアドレスと物理アドレスの対応を追加する。
- f GetIfTable — ローカルマシンのネットワークインターフェイス一覧をMIB_IFTABLEで取得する。
- f GetIpNetTable — IPv4アドレスと物理アドレスの対応を保持するARPテーブルを取得する。