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

FwpmFilterDeleteById0

関数
指定IDのWFPフィルターを削除する。
DLLfwpuclnt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD FwpmFilterDeleteById0(
    FWPM_ENGINE_HANDLE engineHandle,
    ULONGLONG id
);

パラメーター

名前型方向説明
engineHandleFWPM_ENGINE_HANDLEinフィルターエンジンに対して開かれているセッションのハンドル。フィルターエンジンへのセッションを開くには、FwpmEngineOpen0 を呼び出します。
idULONGLONGinシステムから削除されるオブジェクトのランタイム識別子。この値は FwpmFilterAdd0 関数によって返されます。

戻り値の型: DWORD

公式ドキュメント

システムからフィルターオブジェクトを削除します。(FwpmFilterDeleteById0)

戻り値

型: DWORD

戻り値/値 説明
ERROR_SUCCESS
0
フィルターが正常に削除されました。
FWP_E_* エラーコード
0x80320001—0x80320039
Windows フィルタリング プラットフォーム (WFP) 固有のエラーです。詳細については、WFP Error Codes を参照してください。
RPC_* エラーコード
0x80010001—0x80010122
リモートまたはローカルのファイアウォール エンジンとの通信に失敗しました。

解説(Remarks)

この関数は、読み取り専用トランザクション内から呼び出すことはできません。呼び出した場合は FWP_E_INCOMPATIBLE_TXN で失敗します。トランザクションの詳細については、Object Management を参照してください。

この関数は、対応するオブジェクトが同じセッション中に追加された場合に限り、動的セッション内で呼び出すことができます。別の動的セッション中に追加されたオブジェクトに対してこの関数を呼び出した場合は、FWP_E_WRONG_SESSION で失敗します。動的セッション中に追加されたものではないオブジェクトに対してこの関数を呼び出した場合は、FWP_E_DYNAMIC_SESSION_IN_PROGRESS で失敗します。

呼び出し元には、そのフィルターに対する DELETE アクセス権が必要です。詳細については、Access Control を参照してください。

FwpmFilterDeleteById0 は FwpmFilterDeleteById の特定の実装です。詳細については、WFP Version-Independent Names and Targeting Specific Versions of Windows を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

FwpmFilterDeleteById0 = ctypes.windll.fwpuclnt.FwpmFilterDeleteById0
FwpmFilterDeleteById0.restype = wintypes.DWORD
FwpmFilterDeleteById0.argtypes = [
    FWPM_ENGINE_HANDLE,  # engineHandle : FWPM_ENGINE_HANDLE
    ctypes.c_ulonglong,  # id : ULONGLONG
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('fwpuclnt.dll')
FwpmFilterDeleteById0 = Fiddle::Function.new(
  lib['FwpmFilterDeleteById0'],
  [
    Fiddle::TYPE_VOIDP,  # engineHandle : FWPM_ENGINE_HANDLE
    -Fiddle::TYPE_LONG_LONG,  # id : ULONGLONG
  ],
  -Fiddle::TYPE_INT)
#[link(name = "fwpuclnt")]
extern "system" {
    fn FwpmFilterDeleteById0(
        engineHandle: FWPM_ENGINE_HANDLE,  // FWPM_ENGINE_HANDLE
        id: u64  // ULONGLONG
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("fwpuclnt.dll")]
public static extern uint FwpmFilterDeleteById0(FWPM_ENGINE_HANDLE engineHandle, ulong id);
"@
$api = Add-Type -MemberDefinition $sig -Name 'fwpuclnt_FwpmFilterDeleteById0' -Namespace Win32 -PassThru
# $api::FwpmFilterDeleteById0(engineHandle, id)
#uselib "fwpuclnt.dll"
#func global FwpmFilterDeleteById0 "FwpmFilterDeleteById0" sptr, sptr
; FwpmFilterDeleteById0 engineHandle, id   ; 戻り値は stat
; engineHandle : FWPM_ENGINE_HANDLE -> "sptr"
; id : ULONGLONG -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "fwpuclnt.dll"
#cfunc global FwpmFilterDeleteById0 "FwpmFilterDeleteById0" int, int64
; res = FwpmFilterDeleteById0(engineHandle, id)
; engineHandle : FWPM_ENGINE_HANDLE -> "int"
; id : ULONGLONG -> "int64"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
; DWORD FwpmFilterDeleteById0(FWPM_ENGINE_HANDLE engineHandle, ULONGLONG id)
#uselib "fwpuclnt.dll"
#cfunc global FwpmFilterDeleteById0 "FwpmFilterDeleteById0" int, int64
; res = FwpmFilterDeleteById0(engineHandle, id)
; engineHandle : FWPM_ENGINE_HANDLE -> "int"
; id : ULONGLONG -> "int64"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	fwpuclnt = windows.NewLazySystemDLL("fwpuclnt.dll")
	procFwpmFilterDeleteById0 = fwpuclnt.NewProc("FwpmFilterDeleteById0")
)

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

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

typedef FwpmFilterDeleteById0Native = Uint32 Function(FWPM_ENGINE_HANDLE, Uint64);
typedef FwpmFilterDeleteById0Dart = int Function(int, int);
final FwpmFilterDeleteById0 = DynamicLibrary.open('fwpuclnt.dll')
    .lookupFunction<FwpmFilterDeleteById0Native, FwpmFilterDeleteById0Dart>('FwpmFilterDeleteById0');
// engineHandle : FWPM_ENGINE_HANDLE -> FWPM_ENGINE_HANDLE
// id : ULONGLONG -> Uint64
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FwpmFilterDeleteById0(
  engineHandle: FWPM_ENGINE_HANDLE;   // FWPM_ENGINE_HANDLE
  id: UInt64   // ULONGLONG
): DWORD; stdcall;
  external 'fwpuclnt.dll' name 'FwpmFilterDeleteById0';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let fwpmfilterdeletebyid0 =
  foreign "FwpmFilterDeleteById0"
    (FWPM_ENGINE_HANDLE @-> uint64_t @-> returning uint32_t)
(* engineHandle : FWPM_ENGINE_HANDLE -> FWPM_ENGINE_HANDLE *)
(* id : ULONGLONG -> uint64_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library fwpuclnt (t "fwpuclnt.dll"))
(cffi:use-foreign-library fwpuclnt)

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

関連項目

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