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

FwpmEngineOpen0

関数
WFPフィルターエンジンへのセッションを開く。
DLLfwpuclnt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD FwpmEngineOpen0(
    LPCWSTR serverName,   // optional
    DWORD authnService,
    SEC_WINNT_AUTH_IDENTITY_W* authIdentity,   // optional
    const FWPM_SESSION0* session,   // optional
    FWPM_ENGINE_HANDLE* engineHandle
);

パラメーター

名前方向説明
serverNameLPCWSTRinoptional接続先サーバー名。ローカルの場合はNULLを指定する。
authnServiceDWORDin使用する認証サービス(RPC_C_AUTHN_*)を示す値。
authIdentitySEC_WINNT_AUTH_IDENTITY_W*inoptional認証に用いる資格情報へのポインター。現在のコンテキストを使うならNULL可。
sessionFWPM_SESSION0*inoptionalセッションの構成を指定する構造体へのポインター。NULL可。
engineHandleFWPM_ENGINE_HANDLE*out開かれたエンジンハンドルを受け取る出力先。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD FwpmEngineOpen0(
    LPCWSTR serverName,   // optional
    DWORD authnService,
    SEC_WINNT_AUTH_IDENTITY_W* authIdentity,   // optional
    const FWPM_SESSION0* session,   // optional
    FWPM_ENGINE_HANDLE* engineHandle
);
[DllImport("fwpuclnt.dll", ExactSpelling = true)]
static extern uint FwpmEngineOpen0(
    [MarshalAs(UnmanagedType.LPWStr)] string serverName,   // LPCWSTR optional
    uint authnService,   // DWORD
    IntPtr authIdentity,   // SEC_WINNT_AUTH_IDENTITY_W* optional
    IntPtr session,   // FWPM_SESSION0* optional
    IntPtr engineHandle   // FWPM_ENGINE_HANDLE* out
);
<DllImport("fwpuclnt.dll", ExactSpelling:=True)>
Public Shared Function FwpmEngineOpen0(
    <MarshalAs(UnmanagedType.LPWStr)> serverName As String,   ' LPCWSTR optional
    authnService As UInteger,   ' DWORD
    authIdentity As IntPtr,   ' SEC_WINNT_AUTH_IDENTITY_W* optional
    session As IntPtr,   ' FWPM_SESSION0* optional
    engineHandle As IntPtr   ' FWPM_ENGINE_HANDLE* out
) As UInteger
End Function
' serverName : LPCWSTR optional
' authnService : DWORD
' authIdentity : SEC_WINNT_AUTH_IDENTITY_W* optional
' session : FWPM_SESSION0* optional
' engineHandle : FWPM_ENGINE_HANDLE* out
Declare PtrSafe Function FwpmEngineOpen0 Lib "fwpuclnt" ( _
    ByVal serverName As LongPtr, _
    ByVal authnService As Long, _
    ByVal authIdentity As LongPtr, _
    ByVal session As LongPtr, _
    ByVal engineHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FwpmEngineOpen0 = ctypes.windll.fwpuclnt.FwpmEngineOpen0
FwpmEngineOpen0.restype = wintypes.DWORD
FwpmEngineOpen0.argtypes = [
    wintypes.LPCWSTR,  # serverName : LPCWSTR optional
    wintypes.DWORD,  # authnService : DWORD
    ctypes.c_void_p,  # authIdentity : SEC_WINNT_AUTH_IDENTITY_W* optional
    ctypes.c_void_p,  # session : FWPM_SESSION0* optional
    ctypes.c_void_p,  # engineHandle : FWPM_ENGINE_HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('fwpuclnt.dll')
FwpmEngineOpen0 = Fiddle::Function.new(
  lib['FwpmEngineOpen0'],
  [
    Fiddle::TYPE_VOIDP,  # serverName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # authnService : DWORD
    Fiddle::TYPE_VOIDP,  # authIdentity : SEC_WINNT_AUTH_IDENTITY_W* optional
    Fiddle::TYPE_VOIDP,  # session : FWPM_SESSION0* optional
    Fiddle::TYPE_VOIDP,  # engineHandle : FWPM_ENGINE_HANDLE* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "fwpuclnt")]
extern "system" {
    fn FwpmEngineOpen0(
        serverName: *const u16,  // LPCWSTR optional
        authnService: u32,  // DWORD
        authIdentity: *mut SEC_WINNT_AUTH_IDENTITY_W,  // SEC_WINNT_AUTH_IDENTITY_W* optional
        session: *const FWPM_SESSION0,  // FWPM_SESSION0* optional
        engineHandle: *mut FWPM_ENGINE_HANDLE  // FWPM_ENGINE_HANDLE* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("fwpuclnt.dll")]
public static extern uint FwpmEngineOpen0([MarshalAs(UnmanagedType.LPWStr)] string serverName, uint authnService, IntPtr authIdentity, IntPtr session, IntPtr engineHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'fwpuclnt_FwpmEngineOpen0' -Namespace Win32 -PassThru
# $api::FwpmEngineOpen0(serverName, authnService, authIdentity, session, engineHandle)
#uselib "fwpuclnt.dll"
#func global FwpmEngineOpen0 "FwpmEngineOpen0" sptr, sptr, sptr, sptr, sptr
; FwpmEngineOpen0 serverName, authnService, varptr(authIdentity), varptr(session), varptr(engineHandle)   ; 戻り値は stat
; serverName : LPCWSTR optional -> "sptr"
; authnService : DWORD -> "sptr"
; authIdentity : SEC_WINNT_AUTH_IDENTITY_W* optional -> "sptr"
; session : FWPM_SESSION0* optional -> "sptr"
; engineHandle : FWPM_ENGINE_HANDLE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "fwpuclnt.dll"
#cfunc global FwpmEngineOpen0 "FwpmEngineOpen0" wstr, int, var, var, var
; res = FwpmEngineOpen0(serverName, authnService, authIdentity, session, engineHandle)
; serverName : LPCWSTR optional -> "wstr"
; authnService : DWORD -> "int"
; authIdentity : SEC_WINNT_AUTH_IDENTITY_W* optional -> "var"
; session : FWPM_SESSION0* optional -> "var"
; engineHandle : FWPM_ENGINE_HANDLE* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD FwpmEngineOpen0(LPCWSTR serverName, DWORD authnService, SEC_WINNT_AUTH_IDENTITY_W* authIdentity, FWPM_SESSION0* session, FWPM_ENGINE_HANDLE* engineHandle)
#uselib "fwpuclnt.dll"
#cfunc global FwpmEngineOpen0 "FwpmEngineOpen0" wstr, int, var, var, var
; res = FwpmEngineOpen0(serverName, authnService, authIdentity, session, engineHandle)
; serverName : LPCWSTR optional -> "wstr"
; authnService : DWORD -> "int"
; authIdentity : SEC_WINNT_AUTH_IDENTITY_W* optional -> "var"
; session : FWPM_SESSION0* optional -> "var"
; engineHandle : FWPM_ENGINE_HANDLE* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	fwpuclnt = windows.NewLazySystemDLL("fwpuclnt.dll")
	procFwpmEngineOpen0 = fwpuclnt.NewProc("FwpmEngineOpen0")
)

// serverName (LPCWSTR optional), authnService (DWORD), authIdentity (SEC_WINNT_AUTH_IDENTITY_W* optional), session (FWPM_SESSION0* optional), engineHandle (FWPM_ENGINE_HANDLE* out)
r1, _, err := procFwpmEngineOpen0.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(serverName))),
	uintptr(authnService),
	uintptr(authIdentity),
	uintptr(session),
	uintptr(engineHandle),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function FwpmEngineOpen0(
  serverName: PWideChar;   // LPCWSTR optional
  authnService: DWORD;   // DWORD
  authIdentity: Pointer;   // SEC_WINNT_AUTH_IDENTITY_W* optional
  session: Pointer;   // FWPM_SESSION0* optional
  engineHandle: Pointer   // FWPM_ENGINE_HANDLE* out
): DWORD; stdcall;
  external 'fwpuclnt.dll' name 'FwpmEngineOpen0';
result := DllCall("fwpuclnt\FwpmEngineOpen0"
    , "WStr", serverName   ; LPCWSTR optional
    , "UInt", authnService   ; DWORD
    , "Ptr", authIdentity   ; SEC_WINNT_AUTH_IDENTITY_W* optional
    , "Ptr", session   ; FWPM_SESSION0* optional
    , "Ptr", engineHandle   ; FWPM_ENGINE_HANDLE* out
    , "UInt")   ; return: DWORD
●FwpmEngineOpen0(serverName, authnService, authIdentity, session, engineHandle) = DLL("fwpuclnt.dll", "dword FwpmEngineOpen0(char*, dword, void*, void*, void*)")
# 呼び出し: FwpmEngineOpen0(serverName, authnService, authIdentity, session, engineHandle)
# serverName : LPCWSTR optional -> "char*"
# authnService : DWORD -> "dword"
# authIdentity : SEC_WINNT_AUTH_IDENTITY_W* optional -> "void*"
# session : FWPM_SESSION0* optional -> "void*"
# engineHandle : FWPM_ENGINE_HANDLE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef FwpmEngineOpen0Native = Uint32 Function(Pointer<Utf16>, Uint32, Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef FwpmEngineOpen0Dart = int Function(Pointer<Utf16>, int, Pointer<Void>, Pointer<Void>, Pointer<Void>);
final FwpmEngineOpen0 = DynamicLibrary.open('fwpuclnt.dll')
    .lookupFunction<FwpmEngineOpen0Native, FwpmEngineOpen0Dart>('FwpmEngineOpen0');
// serverName : LPCWSTR optional -> Pointer<Utf16>
// authnService : DWORD -> Uint32
// authIdentity : SEC_WINNT_AUTH_IDENTITY_W* optional -> Pointer<Void>
// session : FWPM_SESSION0* optional -> Pointer<Void>
// engineHandle : FWPM_ENGINE_HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FwpmEngineOpen0(
  serverName: PWideChar;   // LPCWSTR optional
  authnService: DWORD;   // DWORD
  authIdentity: Pointer;   // SEC_WINNT_AUTH_IDENTITY_W* optional
  session: Pointer;   // FWPM_SESSION0* optional
  engineHandle: Pointer   // FWPM_ENGINE_HANDLE* out
): DWORD; stdcall;
  external 'fwpuclnt.dll' name 'FwpmEngineOpen0';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FwpmEngineOpen0"
  c_FwpmEngineOpen0 :: CWString -> Word32 -> Ptr () -> Ptr () -> Ptr () -> IO Word32
-- serverName : LPCWSTR optional -> CWString
-- authnService : DWORD -> Word32
-- authIdentity : SEC_WINNT_AUTH_IDENTITY_W* optional -> Ptr ()
-- session : FWPM_SESSION0* optional -> Ptr ()
-- engineHandle : FWPM_ENGINE_HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let fwpmengineopen0 =
  foreign "FwpmEngineOpen0"
    ((ptr uint16_t) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* serverName : LPCWSTR optional -> (ptr uint16_t) *)
(* authnService : DWORD -> uint32_t *)
(* authIdentity : SEC_WINNT_AUTH_IDENTITY_W* optional -> (ptr void) *)
(* session : FWPM_SESSION0* optional -> (ptr void) *)
(* engineHandle : FWPM_ENGINE_HANDLE* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library fwpuclnt (t "fwpuclnt.dll"))
(cffi:use-foreign-library fwpuclnt)

(cffi:defcfun ("FwpmEngineOpen0" fwpm-engine-open0 :convention :stdcall) :uint32
  (server-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (authn-service :uint32)   ; DWORD
  (auth-identity :pointer)   ; SEC_WINNT_AUTH_IDENTITY_W* optional
  (session :pointer)   ; FWPM_SESSION0* optional
  (engine-handle :pointer))   ; FWPM_ENGINE_HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FwpmEngineOpen0 = Win32::API::More->new('fwpuclnt',
    'DWORD FwpmEngineOpen0(LPCWSTR serverName, DWORD authnService, LPVOID authIdentity, LPVOID session, LPVOID engineHandle)');
# my $ret = $FwpmEngineOpen0->Call($serverName, $authnService, $authIdentity, $session, $engineHandle);
# serverName : LPCWSTR optional -> LPCWSTR
# authnService : DWORD -> DWORD
# authIdentity : SEC_WINNT_AUTH_IDENTITY_W* optional -> LPVOID
# session : FWPM_SESSION0* optional -> LPVOID
# engineHandle : FWPM_ENGINE_HANDLE* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型