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

FwpmProviderDeleteByKey0

関数
指定キーのWFPプロバイダーを削除する。
DLLfwpuclnt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD FwpmProviderDeleteByKey0(
    FWPM_ENGINE_HANDLE engineHandle,
    const GUID* key
);

パラメーター

名前型方向説明
engineHandleFWPM_ENGINE_HANDLEinフィルターエンジンへの開かれたセッションのハンドルです。フィルターエンジンへのセッションを開くには、FwpmEngineOpen0 を呼び出します。
keyGUID*inシステムから削除するオブジェクトの一意の識別子です。これは、アプリケーションが FwpmProviderAdd0 を呼び出したときに指定したものと同じ GUID です。

戻り値の型: DWORD

公式ドキュメント

システムからプロバイダーを削除します。

戻り値

種類: DWORD

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

解説(Remarks)

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

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

呼び出し元には、プロバイダーに対する DELETE アクセス権が必要です。詳細については、Access Control を参照してください。

FwpmProviderDeleteByKey0 は、FwpmProviderDeleteByKey の特定の実装です。詳細については、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 FwpmProviderDeleteByKey0(
    FWPM_ENGINE_HANDLE engineHandle,
    const GUID* key
);
[DllImport("fwpuclnt.dll", ExactSpelling = true)]
static extern uint FwpmProviderDeleteByKey0(
    FWPM_ENGINE_HANDLE engineHandle,   // FWPM_ENGINE_HANDLE
    ref Guid key   // GUID*
);
<DllImport("fwpuclnt.dll", ExactSpelling:=True)>
Public Shared Function FwpmProviderDeleteByKey0(
    engineHandle As FWPM_ENGINE_HANDLE,   ' FWPM_ENGINE_HANDLE
    ByRef key As Guid   ' GUID*
) As UInteger
End Function
' engineHandle : FWPM_ENGINE_HANDLE
' key : GUID*
Declare PtrSafe Function FwpmProviderDeleteByKey0 Lib "fwpuclnt" ( _
    ByVal engineHandle As LongPtr, _
    ByVal key As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FwpmProviderDeleteByKey0 = ctypes.windll.fwpuclnt.FwpmProviderDeleteByKey0
FwpmProviderDeleteByKey0.restype = wintypes.DWORD
FwpmProviderDeleteByKey0.argtypes = [
    FWPM_ENGINE_HANDLE,  # engineHandle : FWPM_ENGINE_HANDLE
    ctypes.c_void_p,  # key : GUID*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	fwpuclnt = windows.NewLazySystemDLL("fwpuclnt.dll")
	procFwpmProviderDeleteByKey0 = fwpuclnt.NewProc("FwpmProviderDeleteByKey0")
)

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

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

typedef FwpmProviderDeleteByKey0Native = Uint32 Function(FWPM_ENGINE_HANDLE, Pointer<Void>);
typedef FwpmProviderDeleteByKey0Dart = int Function(int, Pointer<Void>);
final FwpmProviderDeleteByKey0 = DynamicLibrary.open('fwpuclnt.dll')
    .lookupFunction<FwpmProviderDeleteByKey0Native, FwpmProviderDeleteByKey0Dart>('FwpmProviderDeleteByKey0');
// engineHandle : FWPM_ENGINE_HANDLE -> FWPM_ENGINE_HANDLE
// key : GUID* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FwpmProviderDeleteByKey0(
  engineHandle: FWPM_ENGINE_HANDLE;   // FWPM_ENGINE_HANDLE
  key: PGUID   // GUID*
): DWORD; stdcall;
  external 'fwpuclnt.dll' name 'FwpmProviderDeleteByKey0';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

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

関連項目

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