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

PfAddFiltersToInterface

関数
インターフェイスに送受信パケットフィルタを追加する。
DLLIPHLPAPI.dll呼出規約winapi

シグネチャ

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

DWORD PfAddFiltersToInterface(
    void* ih,
    DWORD cInFilters,
    PF_FILTER_DESCRIPTOR* pfiltIn,
    DWORD cOutFilters,
    PF_FILTER_DESCRIPTOR* pfiltOut,
    void** pfHandle
);

パラメーター

名前方向説明
ihvoid*inoutフィルタを追加する対象インターフェースのハンドル。
cInFiltersDWORDinpfiltInが指す受信フィルタ配列の要素数。
pfiltInPF_FILTER_DESCRIPTOR*inout追加する受信方向フィルタを記述したPF_FILTER_DESCRIPTOR配列。なければNULL可。
cOutFiltersDWORDinpfiltOutが指す送信フィルタ配列の要素数。
pfiltOutPF_FILTER_DESCRIPTOR*inout追加する送信方向フィルタを記述したPF_FILTER_DESCRIPTOR配列。なければNULL可。
pfHandlevoid**inout追加された各フィルタのハンドルを受け取る出力バッファ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD PfAddFiltersToInterface(
    void* ih,
    DWORD cInFilters,
    PF_FILTER_DESCRIPTOR* pfiltIn,
    DWORD cOutFilters,
    PF_FILTER_DESCRIPTOR* pfiltOut,
    void** pfHandle
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint PfAddFiltersToInterface(
    IntPtr ih,   // void* in/out
    uint cInFilters,   // DWORD
    IntPtr pfiltIn,   // PF_FILTER_DESCRIPTOR* in/out
    uint cOutFilters,   // DWORD
    IntPtr pfiltOut,   // PF_FILTER_DESCRIPTOR* in/out
    IntPtr pfHandle   // void** in/out
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function PfAddFiltersToInterface(
    ih As IntPtr,   ' void* in/out
    cInFilters As UInteger,   ' DWORD
    pfiltIn As IntPtr,   ' PF_FILTER_DESCRIPTOR* in/out
    cOutFilters As UInteger,   ' DWORD
    pfiltOut As IntPtr,   ' PF_FILTER_DESCRIPTOR* in/out
    pfHandle As IntPtr   ' void** in/out
) As UInteger
End Function
' ih : void* in/out
' cInFilters : DWORD
' pfiltIn : PF_FILTER_DESCRIPTOR* in/out
' cOutFilters : DWORD
' pfiltOut : PF_FILTER_DESCRIPTOR* in/out
' pfHandle : void** in/out
Declare PtrSafe Function PfAddFiltersToInterface Lib "iphlpapi" ( _
    ByVal ih As LongPtr, _
    ByVal cInFilters As Long, _
    ByVal pfiltIn As LongPtr, _
    ByVal cOutFilters As Long, _
    ByVal pfiltOut As LongPtr, _
    ByVal pfHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PfAddFiltersToInterface = ctypes.windll.iphlpapi.PfAddFiltersToInterface
PfAddFiltersToInterface.restype = wintypes.DWORD
PfAddFiltersToInterface.argtypes = [
    ctypes.POINTER(None),  # ih : void* in/out
    wintypes.DWORD,  # cInFilters : DWORD
    ctypes.c_void_p,  # pfiltIn : PF_FILTER_DESCRIPTOR* in/out
    wintypes.DWORD,  # cOutFilters : DWORD
    ctypes.c_void_p,  # pfiltOut : PF_FILTER_DESCRIPTOR* in/out
    ctypes.c_void_p,  # pfHandle : void** in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procPfAddFiltersToInterface = iphlpapi.NewProc("PfAddFiltersToInterface")
)

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

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

typedef PfAddFiltersToInterfaceNative = Uint32 Function(Pointer<Void>, Uint32, Pointer<Void>, Uint32, Pointer<Void>, Pointer<Void>);
typedef PfAddFiltersToInterfaceDart = int Function(Pointer<Void>, int, Pointer<Void>, int, Pointer<Void>, Pointer<Void>);
final PfAddFiltersToInterface = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<PfAddFiltersToInterfaceNative, PfAddFiltersToInterfaceDart>('PfAddFiltersToInterface');
// ih : void* in/out -> Pointer<Void>
// cInFilters : DWORD -> Uint32
// pfiltIn : PF_FILTER_DESCRIPTOR* in/out -> Pointer<Void>
// cOutFilters : DWORD -> Uint32
// pfiltOut : PF_FILTER_DESCRIPTOR* in/out -> Pointer<Void>
// pfHandle : void** in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PfAddFiltersToInterface(
  ih: Pointer;   // void* in/out
  cInFilters: DWORD;   // DWORD
  pfiltIn: Pointer;   // PF_FILTER_DESCRIPTOR* in/out
  cOutFilters: DWORD;   // DWORD
  pfiltOut: Pointer;   // PF_FILTER_DESCRIPTOR* in/out
  pfHandle: Pointer   // void** in/out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'PfAddFiltersToInterface';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PfAddFiltersToInterface"
  c_PfAddFiltersToInterface :: Ptr () -> Word32 -> Ptr () -> Word32 -> Ptr () -> Ptr () -> IO Word32
-- ih : void* in/out -> Ptr ()
-- cInFilters : DWORD -> Word32
-- pfiltIn : PF_FILTER_DESCRIPTOR* in/out -> Ptr ()
-- cOutFilters : DWORD -> Word32
-- pfiltOut : PF_FILTER_DESCRIPTOR* in/out -> Ptr ()
-- pfHandle : void** in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pfaddfilterstointerface =
  foreign "PfAddFiltersToInterface"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* ih : void* in/out -> (ptr void) *)
(* cInFilters : DWORD -> uint32_t *)
(* pfiltIn : PF_FILTER_DESCRIPTOR* in/out -> (ptr void) *)
(* cOutFilters : DWORD -> uint32_t *)
(* pfiltOut : PF_FILTER_DESCRIPTOR* in/out -> (ptr void) *)
(* pfHandle : void** in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("PfAddFiltersToInterface" pf-add-filters-to-interface :convention :stdcall) :uint32
  (ih :pointer)   ; void* in/out
  (c-in-filters :uint32)   ; DWORD
  (pfilt-in :pointer)   ; PF_FILTER_DESCRIPTOR* in/out
  (c-out-filters :uint32)   ; DWORD
  (pfilt-out :pointer)   ; PF_FILTER_DESCRIPTOR* in/out
  (pf-handle :pointer))   ; void** in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PfAddFiltersToInterface = Win32::API::More->new('IPHLPAPI',
    'DWORD PfAddFiltersToInterface(LPVOID ih, DWORD cInFilters, LPVOID pfiltIn, DWORD cOutFilters, LPVOID pfiltOut, LPVOID pfHandle)');
# my $ret = $PfAddFiltersToInterface->Call($ih, $cInFilters, $pfiltIn, $cOutFilters, $pfiltOut, $pfHandle);
# ih : void* in/out -> LPVOID
# cInFilters : DWORD -> DWORD
# pfiltIn : PF_FILTER_DESCRIPTOR* in/out -> LPVOID
# cOutFilters : DWORD -> DWORD
# pfiltOut : PF_FILTER_DESCRIPTOR* in/out -> LPVOID
# pfHandle : void** in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型