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

FwpmCalloutAdd0

関数
WFPにコールアウトを追加する。
DLLfwpuclnt.dll呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

DWORD FwpmCalloutAdd0(
    FWPM_ENGINE_HANDLE engineHandle,
    const FWPM_CALLOUT0* callout,
    PSECURITY_DESCRIPTOR sd,   // optional
    DWORD* id   // optional
);

パラメーター

名前型方向説明
engineHandleFWPM_ENGINE_HANDLEinフィルタリングエンジンへのセッションハンドル。
calloutFWPM_CALLOUT0*in追加するコールアウトの定義を保持するFWPM_CALLOUT0構造体。
sdPSECURITY_DESCRIPTORinoptional新規コールアウトに設定するセキュリティ記述子。NULL可でデフォルトを使用する。
idDWORD*outoptional割り当てられたコールアウトの実行時IDを受け取る出力。不要ならNULL可。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

FwpmCalloutAdd0 = ctypes.windll.fwpuclnt.FwpmCalloutAdd0
FwpmCalloutAdd0.restype = wintypes.DWORD
FwpmCalloutAdd0.argtypes = [
    FWPM_ENGINE_HANDLE,  # engineHandle : FWPM_ENGINE_HANDLE
    ctypes.c_void_p,  # callout : FWPM_CALLOUT0*
    wintypes.HANDLE,  # sd : PSECURITY_DESCRIPTOR optional
    ctypes.POINTER(wintypes.DWORD),  # id : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	fwpuclnt = windows.NewLazySystemDLL("fwpuclnt.dll")
	procFwpmCalloutAdd0 = fwpuclnt.NewProc("FwpmCalloutAdd0")
)

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

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

typedef FwpmCalloutAdd0Native = Uint32 Function(FWPM_ENGINE_HANDLE, Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
typedef FwpmCalloutAdd0Dart = int Function(int, Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
final FwpmCalloutAdd0 = DynamicLibrary.open('fwpuclnt.dll')
    .lookupFunction<FwpmCalloutAdd0Native, FwpmCalloutAdd0Dart>('FwpmCalloutAdd0');
// engineHandle : FWPM_ENGINE_HANDLE -> FWPM_ENGINE_HANDLE
// callout : FWPM_CALLOUT0* -> Pointer<Void>
// sd : PSECURITY_DESCRIPTOR optional -> Pointer<Void>
// id : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FwpmCalloutAdd0(
  engineHandle: FWPM_ENGINE_HANDLE;   // FWPM_ENGINE_HANDLE
  callout: Pointer;   // FWPM_CALLOUT0*
  sd: THandle;   // PSECURITY_DESCRIPTOR optional
  id: Pointer   // DWORD* optional, out
): DWORD; stdcall;
  external 'fwpuclnt.dll' name 'FwpmCalloutAdd0';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let fwpmcalloutadd0 =
  foreign "FwpmCalloutAdd0"
    (FWPM_ENGINE_HANDLE @-> (ptr void) @-> (ptr void) @-> (ptr uint32_t) @-> returning uint32_t)
(* engineHandle : FWPM_ENGINE_HANDLE -> FWPM_ENGINE_HANDLE *)
(* callout : FWPM_CALLOUT0* -> (ptr void) *)
(* sd : PSECURITY_DESCRIPTOR optional -> (ptr void) *)
(* id : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library fwpuclnt (t "fwpuclnt.dll"))
(cffi:use-foreign-library fwpuclnt)

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

関連項目

使用する型