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

FwpmEngineGetOption0

関数
WFPフィルターエンジンのオプション値を取得する。
DLLfwpuclnt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD FwpmEngineGetOption0(
    FWPM_ENGINE_HANDLE engineHandle,
    FWPM_ENGINE_OPTION option,
    FWP_VALUE0** value
);

パラメーター

名前方向説明
engineHandleFWPM_ENGINE_HANDLEinFwpmEngineOpenで取得したフィルターエンジンへのオープンセッションハンドル。
optionFWPM_ENGINE_OPTIONin取得するエンジンオプションの種別を示す列挙値。
valueFWP_VALUE0**out取得したオプション値を受け取るポインター。FwpmFreeMemoryで解放する。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

FwpmEngineGetOption0 = ctypes.windll.fwpuclnt.FwpmEngineGetOption0
FwpmEngineGetOption0.restype = wintypes.DWORD
FwpmEngineGetOption0.argtypes = [
    FWPM_ENGINE_HANDLE,  # engineHandle : FWPM_ENGINE_HANDLE
    ctypes.c_int,  # option : FWPM_ENGINE_OPTION
    ctypes.c_void_p,  # value : FWP_VALUE0** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	fwpuclnt = windows.NewLazySystemDLL("fwpuclnt.dll")
	procFwpmEngineGetOption0 = fwpuclnt.NewProc("FwpmEngineGetOption0")
)

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

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

typedef FwpmEngineGetOption0Native = Uint32 Function(FWPM_ENGINE_HANDLE, Int32, Pointer<Void>);
typedef FwpmEngineGetOption0Dart = int Function(int, int, Pointer<Void>);
final FwpmEngineGetOption0 = DynamicLibrary.open('fwpuclnt.dll')
    .lookupFunction<FwpmEngineGetOption0Native, FwpmEngineGetOption0Dart>('FwpmEngineGetOption0');
// engineHandle : FWPM_ENGINE_HANDLE -> FWPM_ENGINE_HANDLE
// option : FWPM_ENGINE_OPTION -> Int32
// value : FWP_VALUE0** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FwpmEngineGetOption0(
  engineHandle: FWPM_ENGINE_HANDLE;   // FWPM_ENGINE_HANDLE
  option: Integer;   // FWPM_ENGINE_OPTION
  value: Pointer   // FWP_VALUE0** out
): DWORD; stdcall;
  external 'fwpuclnt.dll' name 'FwpmEngineGetOption0';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let fwpmenginegetoption0 =
  foreign "FwpmEngineGetOption0"
    (FWPM_ENGINE_HANDLE @-> int32_t @-> (ptr void) @-> returning uint32_t)
(* engineHandle : FWPM_ENGINE_HANDLE -> FWPM_ENGINE_HANDLE *)
(* option : FWPM_ENGINE_OPTION -> int32_t *)
(* value : FWP_VALUE0** 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 ("FwpmEngineGetOption0" fwpm-engine-get-option0 :convention :stdcall) :uint32
  (engine-handle (:struct fwpm-engine-handle))   ; FWPM_ENGINE_HANDLE
  (option :int32)   ; FWPM_ENGINE_OPTION
  (value :pointer))   ; FWP_VALUE0** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FwpmEngineGetOption0 = Win32::API::More->new('fwpuclnt',
    'DWORD FwpmEngineGetOption0(LPVOID engineHandle, int option, LPVOID value)');
# my $ret = $FwpmEngineGetOption0->Call($engineHandle, $option, $value);
# engineHandle : FWPM_ENGINE_HANDLE -> LPVOID
# option : FWPM_ENGINE_OPTION -> int
# value : FWP_VALUE0** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型