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

FwpmLayerEnum0

関数
WFPレイヤーを列挙して情報を取得する。
DLLfwpuclnt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD FwpmLayerEnum0(
    FWPM_ENGINE_HANDLE engineHandle,
    FWPM_LAYER_ENUM_HANDLE enumHandle,
    DWORD numEntriesRequested,
    FWPM_LAYER0*** entries,
    DWORD* numEntriesReturned
);

パラメーター

名前方向説明
engineHandleFWPM_ENGINE_HANDLEinFwpmEngineOpen0で取得したフィルタリングエンジンへのセッションハンドル。
enumHandleFWPM_LAYER_ENUM_HANDLEinFwpmLayerCreateEnumHandle0で取得した列挙ハンドル。列挙位置を保持する。
numEntriesRequestedDWORDin今回の呼び出しで取得を要求するレイヤーの最大数。
entriesFWPM_LAYER0***out返されるFWPM_LAYER0配列を受け取るポインタ。FwpmFreeMemory0で解放する。
numEntriesReturnedDWORD*out実際に返されたレイヤー数を受け取る出力。要求数未満なら列挙終了を示す。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

FwpmLayerEnum0 = ctypes.windll.fwpuclnt.FwpmLayerEnum0
FwpmLayerEnum0.restype = wintypes.DWORD
FwpmLayerEnum0.argtypes = [
    FWPM_ENGINE_HANDLE,  # engineHandle : FWPM_ENGINE_HANDLE
    FWPM_LAYER_ENUM_HANDLE,  # enumHandle : FWPM_LAYER_ENUM_HANDLE
    wintypes.DWORD,  # numEntriesRequested : DWORD
    ctypes.c_void_p,  # entries : FWPM_LAYER0*** out
    ctypes.POINTER(wintypes.DWORD),  # numEntriesReturned : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	fwpuclnt = windows.NewLazySystemDLL("fwpuclnt.dll")
	procFwpmLayerEnum0 = fwpuclnt.NewProc("FwpmLayerEnum0")
)

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

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

typedef FwpmLayerEnum0Native = Uint32 Function(FWPM_ENGINE_HANDLE, FWPM_LAYER_ENUM_HANDLE, Uint32, Pointer<Void>, Pointer<Uint32>);
typedef FwpmLayerEnum0Dart = int Function(int, int, int, Pointer<Void>, Pointer<Uint32>);
final FwpmLayerEnum0 = DynamicLibrary.open('fwpuclnt.dll')
    .lookupFunction<FwpmLayerEnum0Native, FwpmLayerEnum0Dart>('FwpmLayerEnum0');
// engineHandle : FWPM_ENGINE_HANDLE -> FWPM_ENGINE_HANDLE
// enumHandle : FWPM_LAYER_ENUM_HANDLE -> FWPM_LAYER_ENUM_HANDLE
// numEntriesRequested : DWORD -> Uint32
// entries : FWPM_LAYER0*** out -> Pointer<Void>
// numEntriesReturned : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FwpmLayerEnum0(
  engineHandle: FWPM_ENGINE_HANDLE;   // FWPM_ENGINE_HANDLE
  enumHandle: FWPM_LAYER_ENUM_HANDLE;   // FWPM_LAYER_ENUM_HANDLE
  numEntriesRequested: DWORD;   // DWORD
  entries: Pointer;   // FWPM_LAYER0*** out
  numEntriesReturned: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'fwpuclnt.dll' name 'FwpmLayerEnum0';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let fwpmlayerenum0 =
  foreign "FwpmLayerEnum0"
    (FWPM_ENGINE_HANDLE @-> FWPM_LAYER_ENUM_HANDLE @-> uint32_t @-> (ptr void) @-> (ptr uint32_t) @-> returning uint32_t)
(* engineHandle : FWPM_ENGINE_HANDLE -> FWPM_ENGINE_HANDLE *)
(* enumHandle : FWPM_LAYER_ENUM_HANDLE -> FWPM_LAYER_ENUM_HANDLE *)
(* numEntriesRequested : DWORD -> uint32_t *)
(* entries : FWPM_LAYER0*** out -> (ptr void) *)
(* numEntriesReturned : DWORD* 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 ("FwpmLayerEnum0" fwpm-layer-enum0 :convention :stdcall) :uint32
  (engine-handle (:struct fwpm-engine-handle))   ; FWPM_ENGINE_HANDLE
  (enum-handle (:struct fwpm-layer-enum-handle))   ; FWPM_LAYER_ENUM_HANDLE
  (num-entries-requested :uint32)   ; DWORD
  (entries :pointer)   ; FWPM_LAYER0*** out
  (num-entries-returned :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FwpmLayerEnum0 = Win32::API::More->new('fwpuclnt',
    'DWORD FwpmLayerEnum0(LPVOID engineHandle, LPVOID enumHandle, DWORD numEntriesRequested, LPVOID entries, LPVOID numEntriesReturned)');
# my $ret = $FwpmLayerEnum0->Call($engineHandle, $enumHandle, $numEntriesRequested, $entries, $numEntriesReturned);
# engineHandle : FWPM_ENGINE_HANDLE -> LPVOID
# enumHandle : FWPM_LAYER_ENUM_HANDLE -> LPVOID
# numEntriesRequested : DWORD -> DWORD
# entries : FWPM_LAYER0*** out -> LPVOID
# numEntriesReturned : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型