Win32 API 日本語リファレンス
ホームStorage.Jet › JetGetSessionParameter

JetGetSessionParameter

関数
ESEセッションのパラメータ値を取得する。
DLLESENT.dll呼出規約winapi

シグネチャ

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

INT JetGetSessionParameter(
    JET_SESID sesid,   // optional
    DWORD sesparamid,
    void* pvParam,
    DWORD cbParamMax,
    DWORD* pcbParamActual   // optional
);

パラメーター

名前方向説明
sesidJET_SESIDinoptionalパラメータを取得する対象のJETセッションID。
sesparamidDWORDin取得するセッションパラメータの識別子(JET_sesparam*)。
pvParamvoid*out取得した値を受け取る出力バッファへのポインタ。
cbParamMaxDWORDinpvParamバッファのバイト単位の最大サイズ。
pcbParamActualDWORD*outoptional実際に書き込まれた値のバイト数を受け取る出力ポインタ。

戻り値の型: INT

各言語での呼び出し定義

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

INT JetGetSessionParameter(
    JET_SESID sesid,   // optional
    DWORD sesparamid,
    void* pvParam,
    DWORD cbParamMax,
    DWORD* pcbParamActual   // optional
);
[DllImport("ESENT.dll", ExactSpelling = true)]
static extern int JetGetSessionParameter(
    UIntPtr sesid,   // JET_SESID optional
    uint sesparamid,   // DWORD
    IntPtr pvParam,   // void* out
    uint cbParamMax,   // DWORD
    IntPtr pcbParamActual   // DWORD* optional, out
);
<DllImport("ESENT.dll", ExactSpelling:=True)>
Public Shared Function JetGetSessionParameter(
    sesid As UIntPtr,   ' JET_SESID optional
    sesparamid As UInteger,   ' DWORD
    pvParam As IntPtr,   ' void* out
    cbParamMax As UInteger,   ' DWORD
    pcbParamActual As IntPtr   ' DWORD* optional, out
) As Integer
End Function
' sesid : JET_SESID optional
' sesparamid : DWORD
' pvParam : void* out
' cbParamMax : DWORD
' pcbParamActual : DWORD* optional, out
Declare PtrSafe Function JetGetSessionParameter Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal sesparamid As Long, _
    ByVal pvParam As LongPtr, _
    ByVal cbParamMax As Long, _
    ByVal pcbParamActual As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

JetGetSessionParameter = ctypes.windll.esent.JetGetSessionParameter
JetGetSessionParameter.restype = ctypes.c_int
JetGetSessionParameter.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID optional
    wintypes.DWORD,  # sesparamid : DWORD
    ctypes.POINTER(None),  # pvParam : void* out
    wintypes.DWORD,  # cbParamMax : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbParamActual : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetGetSessionParameter = Fiddle::Function.new(
  lib['JetGetSessionParameter'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID optional
    -Fiddle::TYPE_INT,  # sesparamid : DWORD
    Fiddle::TYPE_VOIDP,  # pvParam : void* out
    -Fiddle::TYPE_INT,  # cbParamMax : DWORD
    Fiddle::TYPE_VOIDP,  # pcbParamActual : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "esent")]
extern "system" {
    fn JetGetSessionParameter(
        sesid: usize,  // JET_SESID optional
        sesparamid: u32,  // DWORD
        pvParam: *mut (),  // void* out
        cbParamMax: u32,  // DWORD
        pcbParamActual: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ESENT.dll")]
public static extern int JetGetSessionParameter(UIntPtr sesid, uint sesparamid, IntPtr pvParam, uint cbParamMax, IntPtr pcbParamActual);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetGetSessionParameter' -Namespace Win32 -PassThru
# $api::JetGetSessionParameter(sesid, sesparamid, pvParam, cbParamMax, pcbParamActual)
#uselib "ESENT.dll"
#func global JetGetSessionParameter "JetGetSessionParameter" sptr, sptr, sptr, sptr, sptr
; JetGetSessionParameter sesid, sesparamid, pvParam, cbParamMax, varptr(pcbParamActual)   ; 戻り値は stat
; sesid : JET_SESID optional -> "sptr"
; sesparamid : DWORD -> "sptr"
; pvParam : void* out -> "sptr"
; cbParamMax : DWORD -> "sptr"
; pcbParamActual : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ESENT.dll"
#cfunc global JetGetSessionParameter "JetGetSessionParameter" sptr, int, sptr, int, var
; res = JetGetSessionParameter(sesid, sesparamid, pvParam, cbParamMax, pcbParamActual)
; sesid : JET_SESID optional -> "sptr"
; sesparamid : DWORD -> "int"
; pvParam : void* out -> "sptr"
; cbParamMax : DWORD -> "int"
; pcbParamActual : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT JetGetSessionParameter(JET_SESID sesid, DWORD sesparamid, void* pvParam, DWORD cbParamMax, DWORD* pcbParamActual)
#uselib "ESENT.dll"
#cfunc global JetGetSessionParameter "JetGetSessionParameter" intptr, int, intptr, int, var
; res = JetGetSessionParameter(sesid, sesparamid, pvParam, cbParamMax, pcbParamActual)
; sesid : JET_SESID optional -> "intptr"
; sesparamid : DWORD -> "int"
; pvParam : void* out -> "intptr"
; cbParamMax : DWORD -> "int"
; pcbParamActual : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetGetSessionParameter = esent.NewProc("JetGetSessionParameter")
)

// sesid (JET_SESID optional), sesparamid (DWORD), pvParam (void* out), cbParamMax (DWORD), pcbParamActual (DWORD* optional, out)
r1, _, err := procJetGetSessionParameter.Call(
	uintptr(sesid),
	uintptr(sesparamid),
	uintptr(pvParam),
	uintptr(cbParamMax),
	uintptr(pcbParamActual),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function JetGetSessionParameter(
  sesid: NativeUInt;   // JET_SESID optional
  sesparamid: DWORD;   // DWORD
  pvParam: Pointer;   // void* out
  cbParamMax: DWORD;   // DWORD
  pcbParamActual: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetSessionParameter';
result := DllCall("ESENT\JetGetSessionParameter"
    , "UPtr", sesid   ; JET_SESID optional
    , "UInt", sesparamid   ; DWORD
    , "Ptr", pvParam   ; void* out
    , "UInt", cbParamMax   ; DWORD
    , "Ptr", pcbParamActual   ; DWORD* optional, out
    , "Int")   ; return: INT
●JetGetSessionParameter(sesid, sesparamid, pvParam, cbParamMax, pcbParamActual) = DLL("ESENT.dll", "int JetGetSessionParameter(int, dword, void*, dword, void*)")
# 呼び出し: JetGetSessionParameter(sesid, sesparamid, pvParam, cbParamMax, pcbParamActual)
# sesid : JET_SESID optional -> "int"
# sesparamid : DWORD -> "dword"
# pvParam : void* out -> "void*"
# cbParamMax : DWORD -> "dword"
# pcbParamActual : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef JetGetSessionParameterNative = Int32 Function(UintPtr, Uint32, Pointer<Void>, Uint32, Pointer<Uint32>);
typedef JetGetSessionParameterDart = int Function(int, int, Pointer<Void>, int, Pointer<Uint32>);
final JetGetSessionParameter = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetGetSessionParameterNative, JetGetSessionParameterDart>('JetGetSessionParameter');
// sesid : JET_SESID optional -> UintPtr
// sesparamid : DWORD -> Uint32
// pvParam : void* out -> Pointer<Void>
// cbParamMax : DWORD -> Uint32
// pcbParamActual : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetGetSessionParameter(
  sesid: NativeUInt;   // JET_SESID optional
  sesparamid: DWORD;   // DWORD
  pvParam: Pointer;   // void* out
  cbParamMax: DWORD;   // DWORD
  pcbParamActual: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetSessionParameter';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetGetSessionParameter"
  c_JetGetSessionParameter :: CUIntPtr -> Word32 -> Ptr () -> Word32 -> Ptr Word32 -> IO Int32
-- sesid : JET_SESID optional -> CUIntPtr
-- sesparamid : DWORD -> Word32
-- pvParam : void* out -> Ptr ()
-- cbParamMax : DWORD -> Word32
-- pcbParamActual : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetgetsessionparameter =
  foreign "JetGetSessionParameter"
    (size_t @-> uint32_t @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* sesid : JET_SESID optional -> size_t *)
(* sesparamid : DWORD -> uint32_t *)
(* pvParam : void* out -> (ptr void) *)
(* cbParamMax : DWORD -> uint32_t *)
(* pcbParamActual : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library esent (t "ESENT.dll"))
(cffi:use-foreign-library esent)

(cffi:defcfun ("JetGetSessionParameter" jet-get-session-parameter :convention :stdcall) :int32
  (sesid :uint64)   ; JET_SESID optional
  (sesparamid :uint32)   ; DWORD
  (pv-param :pointer)   ; void* out
  (cb-param-max :uint32)   ; DWORD
  (pcb-param-actual :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetGetSessionParameter = Win32::API::More->new('ESENT',
    'int JetGetSessionParameter(WPARAM sesid, DWORD sesparamid, LPVOID pvParam, DWORD cbParamMax, LPVOID pcbParamActual)');
# my $ret = $JetGetSessionParameter->Call($sesid, $sesparamid, $pvParam, $cbParamMax, $pcbParamActual);
# sesid : JET_SESID optional -> WPARAM
# sesparamid : DWORD -> DWORD
# pvParam : void* out -> LPVOID
# cbParamMax : DWORD -> DWORD
# pcbParamActual : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。