ホーム › NetworkManagement.WindowsFilteringPlatform › FwpmFilterCreateEnumHandle0

FwpmFilterCreateEnumHandle0

関数

WFPフィルター列挙用のハンドルを作成する。

DLLfwpuclnt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD FwpmFilterCreateEnumHandle0(
    FWPM_ENGINE_HANDLE engineHandle,
    const FWPM_FILTER_ENUM_TEMPLATE0* enumTemplate,   // optional
    FWPM_FILTER_ENUM_HANDLE* enumHandle
);

パラメーター

名前	型	方向	説明
engineHandle	FWPM_ENGINE_HANDLE	in	フィルターエンジンへの開かれたセッションのハンドル。フィルターエンジンへのセッションを開くには、FwpmEngineOpen0 を呼び出します。
enumTemplate	FWPM_FILTER_ENUM_TEMPLATE0*	inoptional	列挙を選択的に制限するためのテンプレート。
enumHandle	FWPM_FILTER_ENUM_HANDLE*	out	フィルター列挙用のハンドル。

戻り値の型: DWORD

公式ドキュメント

フィルターオブジェクトのセットを列挙するために使用するハンドルを作成します。

戻り値

型: DWORD

戻り値/値	説明
ERROR_SUCCESS 0	列挙子が正常に作成されました。
*FWP_E_ エラーコード** 0x80320001—0x80320039	Windows フィルタリングプラットフォーム (WFP) 固有のエラーです。詳細については、WFP Error Codes を参照してください。
*RPC_ エラーコード** 0x80010001—0x80010122	リモートまたはローカルのファイアウォールエンジンとの通信に失敗しました。

解説(Remarks)

enumTemplate が NULL の場合、すべてのフィルターが返されます。

この列挙子は「ライブ」ではありません。つまり、FwpmFilterCreateEnumHandle0 が返された後にシステムに加えられた変更は反映されません。結果が最新であることを保証する必要がある場合は、同一の明示的なトランザクション内から FwpmFilterCreateEnumHandle0 と FwpmFilterEnum0 を呼び出す必要があります。

呼び出し元は、FwpmFilterDestroyEnumHandle0 を呼び出して、返されたハンドルを解放する必要があります。

呼び出し元には、フィルターのコンテナーに対する FWPM_ACTRL_ENUM アクセス権と、フィルターに対する FWPM_ACTRL_READ アクセス権が必要です。呼び出し元が FWPM_ACTRL_READ アクセス権を持つフィルターのみが返されます。詳細については、Access Control を参照してください。

FwpmFilterCreateEnumHandle0 は、FwpmFilterCreateEnumHandle の特定の実装です。詳細については、WFP Version-Independent Names and Targeting Specific Versions of Windows を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

DWORD FwpmFilterCreateEnumHandle0(
    FWPM_ENGINE_HANDLE engineHandle,
    const FWPM_FILTER_ENUM_TEMPLATE0* enumTemplate,   // optional
    FWPM_FILTER_ENUM_HANDLE* enumHandle
);

[DllImport("fwpuclnt.dll", ExactSpelling = true)]
static extern uint FwpmFilterCreateEnumHandle0(
    FWPM_ENGINE_HANDLE engineHandle,   // FWPM_ENGINE_HANDLE
    IntPtr enumTemplate,   // FWPM_FILTER_ENUM_TEMPLATE0* optional
    IntPtr enumHandle   // FWPM_FILTER_ENUM_HANDLE* out
);

<DllImport("fwpuclnt.dll", ExactSpelling:=True)>
Public Shared Function FwpmFilterCreateEnumHandle0(
    engineHandle As FWPM_ENGINE_HANDLE,   ' FWPM_ENGINE_HANDLE
    enumTemplate As IntPtr,   ' FWPM_FILTER_ENUM_TEMPLATE0* optional
    enumHandle As IntPtr   ' FWPM_FILTER_ENUM_HANDLE* out
) As UInteger
End Function

' engineHandle : FWPM_ENGINE_HANDLE
' enumTemplate : FWPM_FILTER_ENUM_TEMPLATE0* optional
' enumHandle : FWPM_FILTER_ENUM_HANDLE* out
Declare PtrSafe Function FwpmFilterCreateEnumHandle0 Lib "fwpuclnt" ( _
    ByVal engineHandle As LongPtr, _
    ByVal enumTemplate As LongPtr, _
    ByVal enumHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

FwpmFilterCreateEnumHandle0 = ctypes.windll.fwpuclnt.FwpmFilterCreateEnumHandle0
FwpmFilterCreateEnumHandle0.restype = wintypes.DWORD
FwpmFilterCreateEnumHandle0.argtypes = [
    FWPM_ENGINE_HANDLE,  # engineHandle : FWPM_ENGINE_HANDLE
    ctypes.c_void_p,  # enumTemplate : FWPM_FILTER_ENUM_TEMPLATE0* optional
    ctypes.c_void_p,  # enumHandle : FWPM_FILTER_ENUM_HANDLE* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('fwpuclnt.dll')
FwpmFilterCreateEnumHandle0 = Fiddle::Function.new(
  lib['FwpmFilterCreateEnumHandle0'],
  [
    Fiddle::TYPE_VOIDP,  # engineHandle : FWPM_ENGINE_HANDLE
    Fiddle::TYPE_VOIDP,  # enumTemplate : FWPM_FILTER_ENUM_TEMPLATE0* optional
    Fiddle::TYPE_VOIDP,  # enumHandle : FWPM_FILTER_ENUM_HANDLE* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "fwpuclnt")]
extern "system" {
    fn FwpmFilterCreateEnumHandle0(
        engineHandle: FWPM_ENGINE_HANDLE,  // FWPM_ENGINE_HANDLE
        enumTemplate: *const FWPM_FILTER_ENUM_TEMPLATE0,  // FWPM_FILTER_ENUM_TEMPLATE0* optional
        enumHandle: *mut FWPM_FILTER_ENUM_HANDLE  // FWPM_FILTER_ENUM_HANDLE* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("fwpuclnt.dll")]
public static extern uint FwpmFilterCreateEnumHandle0(FWPM_ENGINE_HANDLE engineHandle, IntPtr enumTemplate, IntPtr enumHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'fwpuclnt_FwpmFilterCreateEnumHandle0' -Namespace Win32 -PassThru
# $api::FwpmFilterCreateEnumHandle0(engineHandle, enumTemplate, enumHandle)

#uselib "fwpuclnt.dll"
#func global FwpmFilterCreateEnumHandle0 "FwpmFilterCreateEnumHandle0" sptr, sptr, sptr
; FwpmFilterCreateEnumHandle0 engineHandle, varptr(enumTemplate), varptr(enumHandle)   ; 戻り値は stat
; engineHandle : FWPM_ENGINE_HANDLE -> "sptr"
; enumTemplate : FWPM_FILTER_ENUM_TEMPLATE0* optional -> "sptr"
; enumHandle : FWPM_FILTER_ENUM_HANDLE* out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "fwpuclnt.dll"
#cfunc global FwpmFilterCreateEnumHandle0 "FwpmFilterCreateEnumHandle0" int, var, var
; res = FwpmFilterCreateEnumHandle0(engineHandle, enumTemplate, enumHandle)
; engineHandle : FWPM_ENGINE_HANDLE -> "int"
; enumTemplate : FWPM_FILTER_ENUM_TEMPLATE0* optional -> "var"
; enumHandle : FWPM_FILTER_ENUM_HANDLE* out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "fwpuclnt.dll"
#cfunc global FwpmFilterCreateEnumHandle0 "FwpmFilterCreateEnumHandle0" int, sptr, sptr
; res = FwpmFilterCreateEnumHandle0(engineHandle, varptr(enumTemplate), varptr(enumHandle))
; engineHandle : FWPM_ENGINE_HANDLE -> "int"
; enumTemplate : FWPM_FILTER_ENUM_TEMPLATE0* optional -> "sptr"
; enumHandle : FWPM_FILTER_ENUM_HANDLE* out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。