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

IkeextSaGetById1

関数
指定したIDのIKE/AuthIP SA詳細(バージョン1)を取得する。
DLLfwpuclnt.dll呼出規約winapi対応OSWindows 7 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

DWORD IkeextSaGetById1(
    FWPM_ENGINE_HANDLE engineHandle,
    ULONGLONG id,
    GUID* saLookupContext,   // optional
    IKEEXT_SA_DETAILS1** sa
);

パラメーター

名前型方向説明
engineHandleFWPM_ENGINE_HANDLEinフィルタリングエンジンへのセッションハンドル。
idULONGLONGin取得対象IKE/AuthIP SAの実行時ID。
saLookupContextGUID*inoptionalSAを一意に特定するための検索コンテキストGUID。NULL可。
saIKEEXT_SA_DETAILS1**out取得したIKEEXT_SA_DETAILS1を受け取るポインタ。FwpmFreeMemory0で解放する。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

IkeextSaGetById1 = ctypes.windll.fwpuclnt.IkeextSaGetById1
IkeextSaGetById1.restype = wintypes.DWORD
IkeextSaGetById1.argtypes = [
    FWPM_ENGINE_HANDLE,  # engineHandle : FWPM_ENGINE_HANDLE
    ctypes.c_ulonglong,  # id : ULONGLONG
    ctypes.c_void_p,  # saLookupContext : GUID* optional
    ctypes.c_void_p,  # sa : IKEEXT_SA_DETAILS1** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('fwpuclnt.dll')
IkeextSaGetById1 = Fiddle::Function.new(
  lib['IkeextSaGetById1'],
  [
    Fiddle::TYPE_VOIDP,  # engineHandle : FWPM_ENGINE_HANDLE
    -Fiddle::TYPE_LONG_LONG,  # id : ULONGLONG
    Fiddle::TYPE_VOIDP,  # saLookupContext : GUID* optional
    Fiddle::TYPE_VOIDP,  # sa : IKEEXT_SA_DETAILS1** out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "fwpuclnt")]
extern "system" {
    fn IkeextSaGetById1(
        engineHandle: FWPM_ENGINE_HANDLE,  // FWPM_ENGINE_HANDLE
        id: u64,  // ULONGLONG
        saLookupContext: *mut GUID,  // GUID* optional
        sa: *mut *mut IKEEXT_SA_DETAILS1  // IKEEXT_SA_DETAILS1** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("fwpuclnt.dll")]
public static extern uint IkeextSaGetById1(FWPM_ENGINE_HANDLE engineHandle, ulong id, IntPtr saLookupContext, IntPtr sa);
"@
$api = Add-Type -MemberDefinition $sig -Name 'fwpuclnt_IkeextSaGetById1' -Namespace Win32 -PassThru
# $api::IkeextSaGetById1(engineHandle, id, saLookupContext, sa)
#uselib "fwpuclnt.dll"
#func global IkeextSaGetById1 "IkeextSaGetById1" sptr, sptr, sptr, sptr
; IkeextSaGetById1 engineHandle, id, varptr(saLookupContext), varptr(sa)   ; 戻り値は stat
; engineHandle : FWPM_ENGINE_HANDLE -> "sptr"
; id : ULONGLONG -> "sptr"
; saLookupContext : GUID* optional -> "sptr"
; sa : IKEEXT_SA_DETAILS1** out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "fwpuclnt.dll"
#cfunc global IkeextSaGetById1 "IkeextSaGetById1" int, int64, var, var
; res = IkeextSaGetById1(engineHandle, id, saLookupContext, sa)
; engineHandle : FWPM_ENGINE_HANDLE -> "int"
; id : ULONGLONG -> "int64"
; saLookupContext : GUID* optional -> "var"
; sa : IKEEXT_SA_DETAILS1** out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数: 
; DWORD IkeextSaGetById1(FWPM_ENGINE_HANDLE engineHandle, ULONGLONG id, GUID* saLookupContext, IKEEXT_SA_DETAILS1** sa)
#uselib "fwpuclnt.dll"
#cfunc global IkeextSaGetById1 "IkeextSaGetById1" int, int64, var, var
; res = IkeextSaGetById1(engineHandle, id, saLookupContext, sa)
; engineHandle : FWPM_ENGINE_HANDLE -> "int"
; id : ULONGLONG -> "int64"
; saLookupContext : GUID* optional -> "var"
; sa : IKEEXT_SA_DETAILS1** out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	fwpuclnt = windows.NewLazySystemDLL("fwpuclnt.dll")
	procIkeextSaGetById1 = fwpuclnt.NewProc("IkeextSaGetById1")
)

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

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

typedef IkeextSaGetById1Native = Uint32 Function(FWPM_ENGINE_HANDLE, Uint64, Pointer<Void>, Pointer<Void>);
typedef IkeextSaGetById1Dart = int Function(int, int, Pointer<Void>, Pointer<Void>);
final IkeextSaGetById1 = DynamicLibrary.open('fwpuclnt.dll')
    .lookupFunction<IkeextSaGetById1Native, IkeextSaGetById1Dart>('IkeextSaGetById1');
// engineHandle : FWPM_ENGINE_HANDLE -> FWPM_ENGINE_HANDLE
// id : ULONGLONG -> Uint64
// saLookupContext : GUID* optional -> Pointer<Void>
// sa : IKEEXT_SA_DETAILS1** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function IkeextSaGetById1(
  engineHandle: FWPM_ENGINE_HANDLE;   // FWPM_ENGINE_HANDLE
  id: UInt64;   // ULONGLONG
  saLookupContext: PGUID;   // GUID* optional
  sa: Pointer   // IKEEXT_SA_DETAILS1** out
): DWORD; stdcall;
  external 'fwpuclnt.dll' name 'IkeextSaGetById1';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let ikeextsagetbyid1 =
  foreign "IkeextSaGetById1"
    (FWPM_ENGINE_HANDLE @-> uint64_t @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* engineHandle : FWPM_ENGINE_HANDLE -> FWPM_ENGINE_HANDLE *)
(* id : ULONGLONG -> uint64_t *)
(* saLookupContext : GUID* optional -> (ptr void) *)
(* sa : IKEEXT_SA_DETAILS1** 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 ("IkeextSaGetById1" ikeext-sa-get-by-id1 :convention :stdcall) :uint32
  (engine-handle (:struct fwpm-engine-handle))   ; FWPM_ENGINE_HANDLE
  (id :uint64)   ; ULONGLONG
  (sa-lookup-context :pointer)   ; GUID* optional
  (sa :pointer))   ; IKEEXT_SA_DETAILS1** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $IkeextSaGetById1 = Win32::API::More->new('fwpuclnt',
    'DWORD IkeextSaGetById1(LPVOID engineHandle, UINT64 id, LPVOID saLookupContext, LPVOID sa)');
# my $ret = $IkeextSaGetById1->Call($engineHandle, $id, $saLookupContext, $sa);
# engineHandle : FWPM_ENGINE_HANDLE -> LPVOID
# id : ULONGLONG -> UINT64
# saLookupContext : GUID* optional -> LPVOID
# sa : IKEEXT_SA_DETAILS1** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型