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

FlushIpPathTable

関数
指定アドレスファミリのIPパステーブルを消去する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

WIN32_ERROR FlushIpPathTable(
    ADDRESS_FAMILY Family
);

パラメーター

名前方向説明
FamilyADDRESS_FAMILYin

フラッシュするアドレスファミリ。

アドレスファミリに指定できる値は、Winsock2.h ヘッダーファイルに列挙されています。AF_ アドレスファミリ定数と PF_ プロトコルファミリ定数の値は同一である(例: AF_INETPF_INET)ため、どちらの定数も使用できる点に注意してください。

Windows Vista 以降向けにリリースされた Windows SDK では、ヘッダーファイルの構成が変更され、このメンバーに指定できる値は Ws2def.h ヘッダーファイルで定義されています。Ws2def.h ヘッダーファイルは Winsock2.h に自動的にインクルードされるため、直接使用すべきではありません。

現在サポートされている値は AF_INETAF_INET6AF_UNSPEC です。

意味
AF_UNSPEC
0
アドレスファミリは指定されません。このパラメーターを指定すると、この関数は IPv4 と IPv6 の両方のエントリを含む IP パステーブルをフラッシュします。
AF_INET
2
インターネットプロトコルバージョン 4 (IPv4) アドレスファミリ。このパラメーターを指定すると、この関数は IPv4 エントリのみを含む IP パステーブルをフラッシュします。
AF_INET6
23
インターネットプロトコルバージョン 6 (IPv6) アドレスファミリ。このパラメーターを指定すると、この関数は IPv6 エントリのみを含む IP パステーブルをフラッシュします。

戻り値の型: WIN32_ERROR

公式ドキュメント

FlushIpPathTable 関数は、ローカルコンピューター上の IP パステーブルをフラッシュします。

戻り値

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

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

戻り値 説明
ERROR_ACCESS_DENIED
アクセスが拒否されました。このエラーは、次のような複数の条件で返されます。ユーザーがローカルコンピューター上で必要な管理者権限を持っていない場合、またはアプリケーションが組み込み Administrator(管理者として実行)の昇格されたシェルで実行されていない場合です。
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。このエラーは、Family パラメーターに AF_INETAF_INET6AF_UNSPEC 以外が指定された場合に返されます。
ERROR_NOT_SUPPORTED
要求はサポートされていません。このエラーは、ローカルコンピューターに IPv4 スタックが存在せず、Family パラメーターに AF_INET が指定された場合に返されます。また、ローカルコンピューターに IPv6 スタックが存在せず、Family パラメーターに AF_INET6 が指定された場合にも返されます。さらに、この関数がサポートされていないバージョンの Windows でも返されます。
その他
返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

FlushIpPathTable 関数は Windows Vista 以降で定義されています。

FlushIpPathTable 関数は、ローカルシステム上の IP パスエントリをフラッシュまたは削除します。Family パラメーターを使用して、削除する IP パスエントリを特定の IP アドレスファミリに限定できます。IPv4 と IPv6 の両方の IP パスエントリを削除する場合は、Family パラメーターに AF_UNSPEC を設定します。

Family パラメーターは AF_INETAF_INET6AF_UNSPEC のいずれかに初期化する必要があります。

FlushIpPathTable 関数は、Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出せます。Administrators グループのメンバーでないユーザーが FlushIpPathTable を呼び出した場合、関数の呼び出しは失敗し、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 FlushIpPathTable(
    ADDRESS_FAMILY Family
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint FlushIpPathTable(
    ushort Family   // ADDRESS_FAMILY
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function FlushIpPathTable(
    Family As UShort   ' ADDRESS_FAMILY
) As UInteger
End Function
' Family : ADDRESS_FAMILY
Declare PtrSafe Function FlushIpPathTable Lib "iphlpapi" ( _
    ByVal Family As Integer) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FlushIpPathTable = ctypes.windll.iphlpapi.FlushIpPathTable
FlushIpPathTable.restype = wintypes.DWORD
FlushIpPathTable.argtypes = [
    ctypes.c_ushort,  # Family : ADDRESS_FAMILY
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
FlushIpPathTable = Fiddle::Function.new(
  lib['FlushIpPathTable'],
  [
    -Fiddle::TYPE_SHORT,  # Family : ADDRESS_FAMILY
  ],
  -Fiddle::TYPE_INT)
#[link(name = "iphlpapi")]
extern "system" {
    fn FlushIpPathTable(
        Family: u16  // ADDRESS_FAMILY
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint FlushIpPathTable(ushort Family);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_FlushIpPathTable' -Namespace Win32 -PassThru
# $api::FlushIpPathTable(Family)
#uselib "IPHLPAPI.dll"
#func global FlushIpPathTable "FlushIpPathTable" sptr
; FlushIpPathTable Family   ; 戻り値は stat
; Family : ADDRESS_FAMILY -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "IPHLPAPI.dll"
#cfunc global FlushIpPathTable "FlushIpPathTable" int
; res = FlushIpPathTable(Family)
; Family : ADDRESS_FAMILY -> "int"
; WIN32_ERROR FlushIpPathTable(ADDRESS_FAMILY Family)
#uselib "IPHLPAPI.dll"
#cfunc global FlushIpPathTable "FlushIpPathTable" int
; res = FlushIpPathTable(Family)
; Family : ADDRESS_FAMILY -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procFlushIpPathTable = iphlpapi.NewProc("FlushIpPathTable")
)

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

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

typedef FlushIpPathTableNative = Uint32 Function(Uint16);
typedef FlushIpPathTableDart = int Function(int);
final FlushIpPathTable = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<FlushIpPathTableNative, FlushIpPathTableDart>('FlushIpPathTable');
// Family : ADDRESS_FAMILY -> Uint16
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FlushIpPathTable(
  Family: Word   // ADDRESS_FAMILY
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'FlushIpPathTable';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FlushIpPathTable"
  c_FlushIpPathTable :: Word16 -> IO Word32
-- Family : ADDRESS_FAMILY -> Word16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("FlushIpPathTable" flush-ip-path-table :convention :stdcall) :uint32
  (family :uint16))   ; ADDRESS_FAMILY
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FlushIpPathTable = Win32::API::More->new('IPHLPAPI',
    'DWORD FlushIpPathTable(WORD Family)');
# my $ret = $FlushIpPathTable->Call($Family);
# Family : ADDRESS_FAMILY -> WORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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