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

IPsecSaContextGetSpi1

関数
IPsec SAコンテキストの受信SPIを取得する(バージョン1)。
DLLfwpuclnt.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

DWORD IPsecSaContextGetSpi1(
    FWPM_ENGINE_HANDLE engineHandle,
    ULONGLONG id,
    const IPSEC_GETSPI1* getSpi,
    DWORD* inboundSpi
);

パラメーター

名前方向説明
engineHandleFWPM_ENGINE_HANDLEinフィルタリングエンジンへのセッションハンドル。
idULONGLONGin対象IPsec SAコンテキストの実行時ID。
getSpiIPSEC_GETSPI1*in受信SPI割り当ての条件を指定するIPSEC_GETSPI1構造体。
inboundSpiDWORD*out割り当てられた受信SPI値を受け取る出力。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

IPsecSaContextGetSpi1 = ctypes.windll.fwpuclnt.IPsecSaContextGetSpi1
IPsecSaContextGetSpi1.restype = wintypes.DWORD
IPsecSaContextGetSpi1.argtypes = [
    FWPM_ENGINE_HANDLE,  # engineHandle : FWPM_ENGINE_HANDLE
    ctypes.c_ulonglong,  # id : ULONGLONG
    ctypes.c_void_p,  # getSpi : IPSEC_GETSPI1*
    ctypes.POINTER(wintypes.DWORD),  # inboundSpi : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	fwpuclnt = windows.NewLazySystemDLL("fwpuclnt.dll")
	procIPsecSaContextGetSpi1 = fwpuclnt.NewProc("IPsecSaContextGetSpi1")
)

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

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

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

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

関連項目

類似 API
使用する型