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

FwpmFilterAdd0

関数
WFPにフィルターを追加する。
DLLfwpuclnt.dll呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

DWORD FwpmFilterAdd0(
    FWPM_ENGINE_HANDLE engineHandle,
    const FWPM_FILTER0* filter,
    PSECURITY_DESCRIPTOR sd,   // optional
    ULONGLONG* id   // optional
);

パラメーター

名前型方向説明
engineHandleFWPM_ENGINE_HANDLEinフィルタリングエンジンへのセッションハンドル。
filterFWPM_FILTER0*in追加するフィルターの定義を保持するFWPM_FILTER0構造体。
sdPSECURITY_DESCRIPTORinoptional新規フィルターに設定するセキュリティ記述子。NULL可でデフォルトを使用する。
idULONGLONG*outoptional割り当てられたフィルターの実行時ID(64ビット)を受け取る出力。不要ならNULL可。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD FwpmFilterAdd0(
    FWPM_ENGINE_HANDLE engineHandle,
    const FWPM_FILTER0* filter,
    PSECURITY_DESCRIPTOR sd,   // optional
    ULONGLONG* id   // optional
);
[DllImport("fwpuclnt.dll", ExactSpelling = true)]
static extern uint FwpmFilterAdd0(
    FWPM_ENGINE_HANDLE engineHandle,   // FWPM_ENGINE_HANDLE
    IntPtr filter,   // FWPM_FILTER0*
    IntPtr sd,   // PSECURITY_DESCRIPTOR optional
    IntPtr id   // ULONGLONG* optional, out
);
<DllImport("fwpuclnt.dll", ExactSpelling:=True)>
Public Shared Function FwpmFilterAdd0(
    engineHandle As FWPM_ENGINE_HANDLE,   ' FWPM_ENGINE_HANDLE
    filter As IntPtr,   ' FWPM_FILTER0*
    sd As IntPtr,   ' PSECURITY_DESCRIPTOR optional
    id As IntPtr   ' ULONGLONG* optional, out
) As UInteger
End Function
' engineHandle : FWPM_ENGINE_HANDLE
' filter : FWPM_FILTER0*
' sd : PSECURITY_DESCRIPTOR optional
' id : ULONGLONG* optional, out
Declare PtrSafe Function FwpmFilterAdd0 Lib "fwpuclnt" ( _
    ByVal engineHandle As LongPtr, _
    ByVal filter As LongPtr, _
    ByVal sd As LongPtr, _
    ByVal id As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FwpmFilterAdd0 = ctypes.windll.fwpuclnt.FwpmFilterAdd0
FwpmFilterAdd0.restype = wintypes.DWORD
FwpmFilterAdd0.argtypes = [
    FWPM_ENGINE_HANDLE,  # engineHandle : FWPM_ENGINE_HANDLE
    ctypes.c_void_p,  # filter : FWPM_FILTER0*
    wintypes.HANDLE,  # sd : PSECURITY_DESCRIPTOR optional
    ctypes.POINTER(ctypes.c_ulonglong),  # id : ULONGLONG* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('fwpuclnt.dll')
FwpmFilterAdd0 = Fiddle::Function.new(
  lib['FwpmFilterAdd0'],
  [
    Fiddle::TYPE_VOIDP,  # engineHandle : FWPM_ENGINE_HANDLE
    Fiddle::TYPE_VOIDP,  # filter : FWPM_FILTER0*
    Fiddle::TYPE_VOIDP,  # sd : PSECURITY_DESCRIPTOR optional
    Fiddle::TYPE_VOIDP,  # id : ULONGLONG* optional, out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "fwpuclnt")]
extern "system" {
    fn FwpmFilterAdd0(
        engineHandle: FWPM_ENGINE_HANDLE,  // FWPM_ENGINE_HANDLE
        filter: *const FWPM_FILTER0,  // FWPM_FILTER0*
        sd: *mut core::ffi::c_void,  // PSECURITY_DESCRIPTOR optional
        id: *mut u64  // ULONGLONG* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("fwpuclnt.dll")]
public static extern uint FwpmFilterAdd0(FWPM_ENGINE_HANDLE engineHandle, IntPtr filter, IntPtr sd, IntPtr id);
"@
$api = Add-Type -MemberDefinition $sig -Name 'fwpuclnt_FwpmFilterAdd0' -Namespace Win32 -PassThru
# $api::FwpmFilterAdd0(engineHandle, filter, sd, id)
#uselib "fwpuclnt.dll"
#func global FwpmFilterAdd0 "FwpmFilterAdd0" sptr, sptr, sptr, sptr
; FwpmFilterAdd0 engineHandle, varptr(filter), sd, varptr(id)   ; 戻り値は stat
; engineHandle : FWPM_ENGINE_HANDLE -> "sptr"
; filter : FWPM_FILTER0* -> "sptr"
; sd : PSECURITY_DESCRIPTOR optional -> "sptr"
; id : ULONGLONG* optional, out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "fwpuclnt.dll"
#cfunc global FwpmFilterAdd0 "FwpmFilterAdd0" int, var, sptr, var
; res = FwpmFilterAdd0(engineHandle, filter, sd, id)
; engineHandle : FWPM_ENGINE_HANDLE -> "int"
; filter : FWPM_FILTER0* -> "var"
; sd : PSECURITY_DESCRIPTOR optional -> "sptr"
; id : ULONGLONG* optional, out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; DWORD FwpmFilterAdd0(FWPM_ENGINE_HANDLE engineHandle, FWPM_FILTER0* filter, PSECURITY_DESCRIPTOR sd, ULONGLONG* id)
#uselib "fwpuclnt.dll"
#cfunc global FwpmFilterAdd0 "FwpmFilterAdd0" int, var, intptr, var
; res = FwpmFilterAdd0(engineHandle, filter, sd, id)
; engineHandle : FWPM_ENGINE_HANDLE -> "int"
; filter : FWPM_FILTER0* -> "var"
; sd : PSECURITY_DESCRIPTOR optional -> "intptr"
; id : ULONGLONG* optional, out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	fwpuclnt = windows.NewLazySystemDLL("fwpuclnt.dll")
	procFwpmFilterAdd0 = fwpuclnt.NewProc("FwpmFilterAdd0")
)

// engineHandle (FWPM_ENGINE_HANDLE), filter (FWPM_FILTER0*), sd (PSECURITY_DESCRIPTOR optional), id (ULONGLONG* optional, out)
r1, _, err := procFwpmFilterAdd0.Call(
	uintptr(engineHandle),
	uintptr(filter),
	uintptr(sd),
	uintptr(id),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function FwpmFilterAdd0(
  engineHandle: FWPM_ENGINE_HANDLE;   // FWPM_ENGINE_HANDLE
  filter: Pointer;   // FWPM_FILTER0*
  sd: THandle;   // PSECURITY_DESCRIPTOR optional
  id: Pointer   // ULONGLONG* optional, out
): DWORD; stdcall;
  external 'fwpuclnt.dll' name 'FwpmFilterAdd0';
result := DllCall("fwpuclnt\FwpmFilterAdd0"
    , "Ptr", engineHandle   ; FWPM_ENGINE_HANDLE
    , "Ptr", filter   ; FWPM_FILTER0*
    , "Ptr", sd   ; PSECURITY_DESCRIPTOR optional
    , "Ptr", id   ; ULONGLONG* optional, out
    , "UInt")   ; return: DWORD
●FwpmFilterAdd0(engineHandle, filter, sd, id) = DLL("fwpuclnt.dll", "dword FwpmFilterAdd0(void*, void*, void*, void*)")
# 呼び出し: FwpmFilterAdd0(engineHandle, filter, sd, id)
# engineHandle : FWPM_ENGINE_HANDLE -> "void*"
# filter : FWPM_FILTER0* -> "void*"
# sd : PSECURITY_DESCRIPTOR optional -> "void*"
# id : ULONGLONG* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef FwpmFilterAdd0Native = Uint32 Function(FWPM_ENGINE_HANDLE, Pointer<Void>, Pointer<Void>, Pointer<Uint64>);
typedef FwpmFilterAdd0Dart = int Function(int, Pointer<Void>, Pointer<Void>, Pointer<Uint64>);
final FwpmFilterAdd0 = DynamicLibrary.open('fwpuclnt.dll')
    .lookupFunction<FwpmFilterAdd0Native, FwpmFilterAdd0Dart>('FwpmFilterAdd0');
// engineHandle : FWPM_ENGINE_HANDLE -> FWPM_ENGINE_HANDLE
// filter : FWPM_FILTER0* -> Pointer<Void>
// sd : PSECURITY_DESCRIPTOR optional -> Pointer<Void>
// id : ULONGLONG* optional, out -> Pointer<Uint64>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FwpmFilterAdd0(
  engineHandle: FWPM_ENGINE_HANDLE;   // FWPM_ENGINE_HANDLE
  filter: Pointer;   // FWPM_FILTER0*
  sd: THandle;   // PSECURITY_DESCRIPTOR optional
  id: Pointer   // ULONGLONG* optional, out
): DWORD; stdcall;
  external 'fwpuclnt.dll' name 'FwpmFilterAdd0';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FwpmFilterAdd0"
  c_FwpmFilterAdd0 :: FWPM_ENGINE_HANDLE -> Ptr () -> Ptr () -> Ptr Word64 -> IO Word32
-- engineHandle : FWPM_ENGINE_HANDLE -> FWPM_ENGINE_HANDLE
-- filter : FWPM_FILTER0* -> Ptr ()
-- sd : PSECURITY_DESCRIPTOR optional -> Ptr ()
-- id : ULONGLONG* optional, out -> Ptr Word64
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。
open Ctypes
open Foreign

let fwpmfilteradd0 =
  foreign "FwpmFilterAdd0"
    (FWPM_ENGINE_HANDLE @-> (ptr void) @-> (ptr void) @-> (ptr uint64_t) @-> returning uint32_t)
(* engineHandle : FWPM_ENGINE_HANDLE -> FWPM_ENGINE_HANDLE *)
(* filter : FWPM_FILTER0* -> (ptr void) *)
(* sd : PSECURITY_DESCRIPTOR optional -> (ptr void) *)
(* id : ULONGLONG* optional, out -> (ptr uint64_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library fwpuclnt (t "fwpuclnt.dll"))
(cffi:use-foreign-library fwpuclnt)

(cffi:defcfun ("FwpmFilterAdd0" fwpm-filter-add0 :convention :stdcall) :uint32
  (engine-handle (:struct fwpm-engine-handle))   ; FWPM_ENGINE_HANDLE
  (filter :pointer)   ; FWPM_FILTER0*
  (sd :pointer)   ; PSECURITY_DESCRIPTOR optional
  (id :pointer))   ; ULONGLONG* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FwpmFilterAdd0 = Win32::API::More->new('fwpuclnt',
    'DWORD FwpmFilterAdd0(LPVOID engineHandle, LPVOID filter, HANDLE sd, LPVOID id)');
# my $ret = $FwpmFilterAdd0->Call($engineHandle, $filter, $sd, $id);
# engineHandle : FWPM_ENGINE_HANDLE -> LPVOID
# filter : FWPM_FILTER0* -> LPVOID
# sd : PSECURITY_DESCRIPTOR optional -> HANDLE
# id : ULONGLONG* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型