ホーム › NetworkManagement.WindowsFilteringPlatform › FwpmTransactionBegin0
FwpmTransactionBegin0
関数WFPエンジンでトランザクションを開始する。
シグネチャ
// fwpuclnt.dll
#include <windows.h>
DWORD FwpmTransactionBegin0(
FWPM_ENGINE_HANDLE engineHandle,
DWORD flags
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|---|
| engineHandle | FWPM_ENGINE_HANDLE | in | フィルターエンジンへの開かれたセッションのハンドル。フィルターエンジンへのセッションを開くには、FwpmEngineOpen0 を呼び出します。 | ||||||
| flags | DWORD | in | 指定できる値:
|
戻り値の型: DWORD
公式ドキュメント
現在のセッション内で明示的なトランザクションを開始します。
戻り値
型: DWORD
| リターンコード/値 | 説明 |
|---|---|
| トランザクションが正常に開始されました。 | |
|
Windows フィルタリング プラットフォーム (WFP) 固有のエラーです。詳細については、WFP エラーコード を参照してください。 |
|
リモートまたはローカルのファイアウォールエンジンとの通信に失敗しました。 |
解説(Remarks)
この関数はトランザクション内から呼び出すことはできません。呼び出した場合は FWP_E_TXN_IN_PROGRESS で失敗します。トランザクションの詳細については、オブジェクトの管理 を参照してください。
読み取り専用トランザクションの場合、呼び出し元にはフィルターエンジンに対する FWPM_ACTRL_BEGIN_READ_TXN アクセス権が必要です。読み取り/書き込みトランザクションの場合、呼び出し元にはフィルターエンジンに対する FWPM_ACTRL_BEGIN_WRITE_TXN アクセス権が必要です。詳細については、アクセス制御 を参照してください。
FwpmTransactionBegin0 は FwpmTransactionBegin の特定の実装です。詳細については、WFP のバージョン非依存の名前と特定バージョンの Windows を対象とする方法 を参照してください。
例
次の C++ の例は、FwpmFilterAdd0 関数を FWP トランザクションでラップする方法を示しています。
#include <windows.h>
#include <fwpmu.h>
#include <stdio.h>
#pragma comment(lib, "Fwpuclnt.lib")
void main()
{
HANDLE engineHandle = NULL;
FWPM_FILTER0 fwpFilter;
RtlZeroMemory(&fwpFilter, sizeof(FWPM_FILTER0));
fwpFilter.layerKey = FWPM_LAYER_ALE_AUTH_RECV_ACCEPT_V4;
fwpFilter.action.type = FWP_ACTION_BLOCK;
fwpFilter.weight.type = FWP_EMPTY;
fwpFilter.numFilterConditions = 0;
DWORD result = ERROR_SUCCESS;
DWORD fwpTxStatus = ERROR_SUCCESS;
printf("Opening filter engine.\n");
result = FwpmEngineOpen0(NULL, RPC_C_AUTHN_WINNT, NULL, NULL, &engineHandle);
if (result != ERROR_SUCCESS)
{
printf("FwpmEngineOpen0 failed (%d).\n", result);
return;
}
printf("Adding filter to permit traffic for Application 1.\n");
fwpTxStatus = FwpmTransactionBegin0(engineHandle, NULL);
if (fwpTxStatus != ERROR_SUCCESS)
{
printf("FwpmTransactionBegin0 failed (%d).\n", fwpTxStatus);
return;
}
result = FwpmFilterAdd0(engineHandle, &fwpFilter, NULL, NULL);
if (result != ERROR_SUCCESS)
{
printf("FwpmFilterAdd0 failed (%d).\n", result);
return;
}
result = FwpmTransactionCommit0(engineHandle);
if (result != ERROR_SUCCESS)
{
printf("FwpmTransactionCommit0 failed (%d).\n", result);
return;
}
else
{
printf("Filter transaction (adding a filter) committed successfully.\n");
}
return;
}
// ----------------------------------------------------------------------
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// fwpuclnt.dll
#include <windows.h>
DWORD FwpmTransactionBegin0(
FWPM_ENGINE_HANDLE engineHandle,
DWORD flags
);[DllImport("fwpuclnt.dll", ExactSpelling = true)]
static extern uint FwpmTransactionBegin0(
FWPM_ENGINE_HANDLE engineHandle, // FWPM_ENGINE_HANDLE
uint flags // DWORD
);<DllImport("fwpuclnt.dll", ExactSpelling:=True)>
Public Shared Function FwpmTransactionBegin0(
engineHandle As FWPM_ENGINE_HANDLE, ' FWPM_ENGINE_HANDLE
flags As UInteger ' DWORD
) As UInteger
End Function' engineHandle : FWPM_ENGINE_HANDLE
' flags : DWORD
Declare PtrSafe Function FwpmTransactionBegin0 Lib "fwpuclnt" ( _
ByVal engineHandle As LongPtr, _
ByVal flags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
FwpmTransactionBegin0 = ctypes.windll.fwpuclnt.FwpmTransactionBegin0
FwpmTransactionBegin0.restype = wintypes.DWORD
FwpmTransactionBegin0.argtypes = [
FWPM_ENGINE_HANDLE, # engineHandle : FWPM_ENGINE_HANDLE
wintypes.DWORD, # flags : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('fwpuclnt.dll')
FwpmTransactionBegin0 = Fiddle::Function.new(
lib['FwpmTransactionBegin0'],
[
Fiddle::TYPE_VOIDP, # engineHandle : FWPM_ENGINE_HANDLE
-Fiddle::TYPE_INT, # flags : DWORD
],
-Fiddle::TYPE_INT)#[link(name = "fwpuclnt")]
extern "system" {
fn FwpmTransactionBegin0(
engineHandle: FWPM_ENGINE_HANDLE, // FWPM_ENGINE_HANDLE
flags: u32 // DWORD
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("fwpuclnt.dll")]
public static extern uint FwpmTransactionBegin0(FWPM_ENGINE_HANDLE engineHandle, uint flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'fwpuclnt_FwpmTransactionBegin0' -Namespace Win32 -PassThru
# $api::FwpmTransactionBegin0(engineHandle, flags)#uselib "fwpuclnt.dll"
#func global FwpmTransactionBegin0 "FwpmTransactionBegin0" sptr, sptr
; FwpmTransactionBegin0 engineHandle, flags ; 戻り値は stat
; engineHandle : FWPM_ENGINE_HANDLE -> "sptr"
; flags : DWORD -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "fwpuclnt.dll"
#cfunc global FwpmTransactionBegin0 "FwpmTransactionBegin0" int, int
; res = FwpmTransactionBegin0(engineHandle, flags)
; engineHandle : FWPM_ENGINE_HANDLE -> "int"
; flags : DWORD -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。; DWORD FwpmTransactionBegin0(FWPM_ENGINE_HANDLE engineHandle, DWORD flags)
#uselib "fwpuclnt.dll"
#cfunc global FwpmTransactionBegin0 "FwpmTransactionBegin0" int, int
; res = FwpmTransactionBegin0(engineHandle, flags)
; engineHandle : FWPM_ENGINE_HANDLE -> "int"
; flags : DWORD -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
fwpuclnt = windows.NewLazySystemDLL("fwpuclnt.dll")
procFwpmTransactionBegin0 = fwpuclnt.NewProc("FwpmTransactionBegin0")
)
// engineHandle (FWPM_ENGINE_HANDLE), flags (DWORD)
r1, _, err := procFwpmTransactionBegin0.Call(
uintptr(engineHandle),
uintptr(flags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction FwpmTransactionBegin0(
engineHandle: FWPM_ENGINE_HANDLE; // FWPM_ENGINE_HANDLE
flags: DWORD // DWORD
): DWORD; stdcall;
external 'fwpuclnt.dll' name 'FwpmTransactionBegin0';result := DllCall("fwpuclnt\FwpmTransactionBegin0"
, "Ptr", engineHandle ; FWPM_ENGINE_HANDLE
, "UInt", flags ; DWORD
, "UInt") ; return: DWORD●FwpmTransactionBegin0(engineHandle, flags) = DLL("fwpuclnt.dll", "dword FwpmTransactionBegin0(void*, dword)")
# 呼び出し: FwpmTransactionBegin0(engineHandle, flags)
# engineHandle : FWPM_ENGINE_HANDLE -> "void*"
# flags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "fwpuclnt" fn FwpmTransactionBegin0(
engineHandle: FWPM_ENGINE_HANDLE, // FWPM_ENGINE_HANDLE
flags: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;proc FwpmTransactionBegin0(
engineHandle: FWPM_ENGINE_HANDLE, # FWPM_ENGINE_HANDLE
flags: uint32 # DWORD
): uint32 {.importc: "FwpmTransactionBegin0", stdcall, dynlib: "fwpuclnt.dll".}pragma(lib, "fwpuclnt");
extern(Windows)
uint FwpmTransactionBegin0(
FWPM_ENGINE_HANDLE engineHandle, // FWPM_ENGINE_HANDLE
uint flags // DWORD
);ccall((:FwpmTransactionBegin0, "fwpuclnt.dll"), stdcall, UInt32,
(FWPM_ENGINE_HANDLE, UInt32),
engineHandle, flags)
# engineHandle : FWPM_ENGINE_HANDLE -> FWPM_ENGINE_HANDLE
# flags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t FwpmTransactionBegin0(
FWPM_ENGINE_HANDLE engineHandle,
uint32_t flags);
]]
local fwpuclnt = ffi.load("fwpuclnt")
-- fwpuclnt.FwpmTransactionBegin0(engineHandle, flags)
-- engineHandle : FWPM_ENGINE_HANDLE
-- flags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('fwpuclnt.dll');
const FwpmTransactionBegin0 = lib.func('__stdcall', 'FwpmTransactionBegin0', 'uint32_t', ['FWPM_ENGINE_HANDLE', 'uint32_t']);
// FwpmTransactionBegin0(engineHandle, flags)
// engineHandle : FWPM_ENGINE_HANDLE -> 'FWPM_ENGINE_HANDLE'
// flags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("fwpuclnt.dll", {
FwpmTransactionBegin0: { parameters: ["buffer", "u32"], result: "u32" },
});
// lib.symbols.FwpmTransactionBegin0(engineHandle, flags)
// engineHandle : FWPM_ENGINE_HANDLE -> "buffer"
// flags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t FwpmTransactionBegin0(
FWPM_ENGINE_HANDLE engineHandle,
uint32_t flags);
C, "fwpuclnt.dll");
// $ffi->FwpmTransactionBegin0(engineHandle, flags);
// engineHandle : FWPM_ENGINE_HANDLE
// flags : DWORD
// 構造体/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 FwpmTransactionBegin0(
FWPM_ENGINE_HANDLE /* extends Structure (by value) */ engineHandle, // FWPM_ENGINE_HANDLE
int flags // DWORD
);
}@[Link("fwpuclnt")]
lib Libfwpuclnt
fun FwpmTransactionBegin0 = FwpmTransactionBegin0(
engineHandle : FWPM_ENGINE_HANDLE, # FWPM_ENGINE_HANDLE
flags : UInt32 # DWORD
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef FwpmTransactionBegin0Native = Uint32 Function(FWPM_ENGINE_HANDLE, Uint32);
typedef FwpmTransactionBegin0Dart = int Function(int, int);
final FwpmTransactionBegin0 = DynamicLibrary.open('fwpuclnt.dll')
.lookupFunction<FwpmTransactionBegin0Native, FwpmTransactionBegin0Dart>('FwpmTransactionBegin0');
// engineHandle : FWPM_ENGINE_HANDLE -> FWPM_ENGINE_HANDLE
// flags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function FwpmTransactionBegin0(
engineHandle: FWPM_ENGINE_HANDLE; // FWPM_ENGINE_HANDLE
flags: DWORD // DWORD
): DWORD; stdcall;
external 'fwpuclnt.dll' name 'FwpmTransactionBegin0';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "FwpmTransactionBegin0"
c_FwpmTransactionBegin0 :: FWPM_ENGINE_HANDLE -> Word32 -> IO Word32
-- engineHandle : FWPM_ENGINE_HANDLE -> FWPM_ENGINE_HANDLE
-- flags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。open Ctypes
open Foreign
let fwpmtransactionbegin0 =
foreign "FwpmTransactionBegin0"
(FWPM_ENGINE_HANDLE @-> uint32_t @-> returning uint32_t)
(* engineHandle : FWPM_ENGINE_HANDLE -> FWPM_ENGINE_HANDLE *)
(* flags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library fwpuclnt (t "fwpuclnt.dll"))
(cffi:use-foreign-library fwpuclnt)
(cffi:defcfun ("FwpmTransactionBegin0" fwpm-transaction-begin0 :convention :stdcall) :uint32
(engine-handle (:struct fwpm-engine-handle)) ; FWPM_ENGINE_HANDLE
(flags :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $FwpmTransactionBegin0 = Win32::API::More->new('fwpuclnt',
'DWORD FwpmTransactionBegin0(LPVOID engineHandle, DWORD flags)');
# my $ret = $FwpmTransactionBegin0->Call($engineHandle, $flags);
# engineHandle : FWPM_ENGINE_HANDLE -> LPVOID
# flags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f FwpmTransactionAbort0 — WFPトランザクションを中止して変更を破棄する。
- f FwpmTransactionCommit0 — WFPトランザクションをコミットして変更を確定する。
使用する型