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

IPsecSaContextCreateEnumHandle0

関数
IPsec SAコンテキスト列挙用のハンドルを作成する。
DLLfwpuclnt.dll呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

DWORD IPsecSaContextCreateEnumHandle0(
    FWPM_ENGINE_HANDLE engineHandle,
    const IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* enumTemplate,   // optional
    IPSEC_SA_CONTEXT_ENUM_HANDLE* enumHandle
);

パラメーター

名前型方向説明
engineHandleFWPM_ENGINE_HANDLEinフィルタリングエンジンへのセッションハンドル。
enumTemplateIPSEC_SA_CONTEXT_ENUM_TEMPLATE0*inoptional列挙条件を指定するテンプレート。NULL指定で全SAコンテキストを列挙する。
enumHandleIPSEC_SA_CONTEXT_ENUM_HANDLE*out作成されたSAコンテキスト列挙ハンドルを受け取る出力。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD IPsecSaContextCreateEnumHandle0(
    FWPM_ENGINE_HANDLE engineHandle,
    const IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* enumTemplate,   // optional
    IPSEC_SA_CONTEXT_ENUM_HANDLE* enumHandle
);
[DllImport("fwpuclnt.dll", ExactSpelling = true)]
static extern uint IPsecSaContextCreateEnumHandle0(
    FWPM_ENGINE_HANDLE engineHandle,   // FWPM_ENGINE_HANDLE
    IntPtr enumTemplate,   // IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* optional
    IntPtr enumHandle   // IPSEC_SA_CONTEXT_ENUM_HANDLE* out
);
<DllImport("fwpuclnt.dll", ExactSpelling:=True)>
Public Shared Function IPsecSaContextCreateEnumHandle0(
    engineHandle As FWPM_ENGINE_HANDLE,   ' FWPM_ENGINE_HANDLE
    enumTemplate As IntPtr,   ' IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* optional
    enumHandle As IntPtr   ' IPSEC_SA_CONTEXT_ENUM_HANDLE* out
) As UInteger
End Function
' engineHandle : FWPM_ENGINE_HANDLE
' enumTemplate : IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* optional
' enumHandle : IPSEC_SA_CONTEXT_ENUM_HANDLE* out
Declare PtrSafe Function IPsecSaContextCreateEnumHandle0 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

IPsecSaContextCreateEnumHandle0 = ctypes.windll.fwpuclnt.IPsecSaContextCreateEnumHandle0
IPsecSaContextCreateEnumHandle0.restype = wintypes.DWORD
IPsecSaContextCreateEnumHandle0.argtypes = [
    FWPM_ENGINE_HANDLE,  # engineHandle : FWPM_ENGINE_HANDLE
    ctypes.c_void_p,  # enumTemplate : IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* optional
    ctypes.c_void_p,  # enumHandle : IPSEC_SA_CONTEXT_ENUM_HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	fwpuclnt = windows.NewLazySystemDLL("fwpuclnt.dll")
	procIPsecSaContextCreateEnumHandle0 = fwpuclnt.NewProc("IPsecSaContextCreateEnumHandle0")
)

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

extern "fwpuclnt" fn IPsecSaContextCreateEnumHandle0(
    engineHandle: FWPM_ENGINE_HANDLE, // FWPM_ENGINE_HANDLE
    enumTemplate: [*c]IPSEC_SA_CONTEXT_ENUM_TEMPLATE0, // IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* optional
    enumHandle: [*c]IPSEC_SA_CONTEXT_ENUM_HANDLE // IPSEC_SA_CONTEXT_ENUM_HANDLE* out
) callconv(std.os.windows.WINAPI) u32;
proc IPsecSaContextCreateEnumHandle0(
    engineHandle: FWPM_ENGINE_HANDLE,  # FWPM_ENGINE_HANDLE
    enumTemplate: ptr IPSEC_SA_CONTEXT_ENUM_TEMPLATE0,  # IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* optional
    enumHandle: ptr IPSEC_SA_CONTEXT_ENUM_HANDLE  # IPSEC_SA_CONTEXT_ENUM_HANDLE* out
): uint32 {.importc: "IPsecSaContextCreateEnumHandle0", stdcall, dynlib: "fwpuclnt.dll".}
pragma(lib, "fwpuclnt");
extern(Windows)
uint IPsecSaContextCreateEnumHandle0(
    FWPM_ENGINE_HANDLE engineHandle,   // FWPM_ENGINE_HANDLE
    IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* enumTemplate,   // IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* optional
    IPSEC_SA_CONTEXT_ENUM_HANDLE* enumHandle   // IPSEC_SA_CONTEXT_ENUM_HANDLE* out
);
ccall((:IPsecSaContextCreateEnumHandle0, "fwpuclnt.dll"), stdcall, UInt32,
      (FWPM_ENGINE_HANDLE, Ptr{IPSEC_SA_CONTEXT_ENUM_TEMPLATE0}, Ptr{IPSEC_SA_CONTEXT_ENUM_HANDLE}),
      engineHandle, enumTemplate, enumHandle)
# engineHandle : FWPM_ENGINE_HANDLE -> FWPM_ENGINE_HANDLE
# enumTemplate : IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* optional -> Ptr{IPSEC_SA_CONTEXT_ENUM_TEMPLATE0}
# enumHandle : IPSEC_SA_CONTEXT_ENUM_HANDLE* out -> Ptr{IPSEC_SA_CONTEXT_ENUM_HANDLE}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t IPsecSaContextCreateEnumHandle0(
    FWPM_ENGINE_HANDLE engineHandle,
    void* enumTemplate,
    void* enumHandle);
]]
local fwpuclnt = ffi.load("fwpuclnt")
-- fwpuclnt.IPsecSaContextCreateEnumHandle0(engineHandle, enumTemplate, enumHandle)
-- engineHandle : FWPM_ENGINE_HANDLE
-- enumTemplate : IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* optional
-- enumHandle : IPSEC_SA_CONTEXT_ENUM_HANDLE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('fwpuclnt.dll');
const IPsecSaContextCreateEnumHandle0 = lib.func('__stdcall', 'IPsecSaContextCreateEnumHandle0', 'uint32_t', ['FWPM_ENGINE_HANDLE', 'void *', 'void *']);
// IPsecSaContextCreateEnumHandle0(engineHandle, enumTemplate, enumHandle)
// engineHandle : FWPM_ENGINE_HANDLE -> 'FWPM_ENGINE_HANDLE'
// enumTemplate : IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* optional -> 'void *'
// enumHandle : IPSEC_SA_CONTEXT_ENUM_HANDLE* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("fwpuclnt.dll", {
  IPsecSaContextCreateEnumHandle0: { parameters: ["buffer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.IPsecSaContextCreateEnumHandle0(engineHandle, enumTemplate, enumHandle)
// engineHandle : FWPM_ENGINE_HANDLE -> "buffer"
// enumTemplate : IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* optional -> "pointer"
// enumHandle : IPSEC_SA_CONTEXT_ENUM_HANDLE* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t IPsecSaContextCreateEnumHandle0(
    FWPM_ENGINE_HANDLE engineHandle,
    void* enumTemplate,
    void* enumHandle);
C, "fwpuclnt.dll");
// $ffi->IPsecSaContextCreateEnumHandle0(engineHandle, enumTemplate, enumHandle);
// engineHandle : FWPM_ENGINE_HANDLE
// enumTemplate : IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* optional
// enumHandle : IPSEC_SA_CONTEXT_ENUM_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 IPsecSaContextCreateEnumHandle0(
        FWPM_ENGINE_HANDLE /* extends Structure (by value) */ engineHandle,   // FWPM_ENGINE_HANDLE
        Pointer enumTemplate,   // IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* optional
        Pointer enumHandle   // IPSEC_SA_CONTEXT_ENUM_HANDLE* out
    );
}
@[Link("fwpuclnt")]
lib Libfwpuclnt
  fun IPsecSaContextCreateEnumHandle0 = IPsecSaContextCreateEnumHandle0(
    engineHandle : FWPM_ENGINE_HANDLE,   # FWPM_ENGINE_HANDLE
    enumTemplate : IPSEC_SA_CONTEXT_ENUM_TEMPLATE0*,   # IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* optional
    enumHandle : IPSEC_SA_CONTEXT_ENUM_HANDLE*   # IPSEC_SA_CONTEXT_ENUM_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 IPsecSaContextCreateEnumHandle0Native = Uint32 Function(FWPM_ENGINE_HANDLE, Pointer<Void>, Pointer<Void>);
typedef IPsecSaContextCreateEnumHandle0Dart = int Function(int, Pointer<Void>, Pointer<Void>);
final IPsecSaContextCreateEnumHandle0 = DynamicLibrary.open('fwpuclnt.dll')
    .lookupFunction<IPsecSaContextCreateEnumHandle0Native, IPsecSaContextCreateEnumHandle0Dart>('IPsecSaContextCreateEnumHandle0');
// engineHandle : FWPM_ENGINE_HANDLE -> FWPM_ENGINE_HANDLE
// enumTemplate : IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* optional -> Pointer<Void>
// enumHandle : IPSEC_SA_CONTEXT_ENUM_HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function IPsecSaContextCreateEnumHandle0(
  engineHandle: FWPM_ENGINE_HANDLE;   // FWPM_ENGINE_HANDLE
  enumTemplate: Pointer;   // IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* optional
  enumHandle: Pointer   // IPSEC_SA_CONTEXT_ENUM_HANDLE* out
): DWORD; stdcall;
  external 'fwpuclnt.dll' name 'IPsecSaContextCreateEnumHandle0';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let ipsecsacontextcreateenumhandle0 =
  foreign "IPsecSaContextCreateEnumHandle0"
    (FWPM_ENGINE_HANDLE @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* engineHandle : FWPM_ENGINE_HANDLE -> FWPM_ENGINE_HANDLE *)
(* enumTemplate : IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* optional -> (ptr void) *)
(* enumHandle : IPSEC_SA_CONTEXT_ENUM_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 ("IPsecSaContextCreateEnumHandle0" ipsec-sa-context-create-enum-handle0 :convention :stdcall) :uint32
  (engine-handle (:struct fwpm-engine-handle))   ; FWPM_ENGINE_HANDLE
  (enum-template :pointer)   ; IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* optional
  (enum-handle :pointer))   ; IPSEC_SA_CONTEXT_ENUM_HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $IPsecSaContextCreateEnumHandle0 = Win32::API::More->new('fwpuclnt',
    'DWORD IPsecSaContextCreateEnumHandle0(LPVOID engineHandle, LPVOID enumTemplate, LPVOID enumHandle)');
# my $ret = $IPsecSaContextCreateEnumHandle0->Call($engineHandle, $enumTemplate, $enumHandle);
# engineHandle : FWPM_ENGINE_HANDLE -> LPVOID
# enumTemplate : IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* optional -> LPVOID
# enumHandle : IPSEC_SA_CONTEXT_ENUM_HANDLE* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型