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
sesparamidDWORDin
pvParamvoid*out
cbParamMaxDWORDin
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)。