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

JetGetSystemParameterA

関数
ESEのシステムパラメーターの値を取得する（ANSI版）。
DLLESENT.dll文字セットANSI (-A)呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

// ESENT.dll  (ANSI / -A)
#include <windows.h>

INT JetGetSystemParameterA(
    JET_INSTANCE instance,
    JET_SESID sesid,   // optional
    DWORD paramid,
    JET_API_PTR* plParam,   // optional
    CHAR* szParam,   // optional
    DWORD cbMax
);

パラメーター

名前型方向説明
instanceJET_INSTANCEin対象インスタンスハンドル。グローバル値取得時はJET_instanceNilを指定する。
sesidJET_SESIDinoptional操作に使用するセッションID。不要な場合はJET_sesidNil。
paramidDWORDin取得するシステムパラメータの識別子(JET_param系定数)。
plParamJET_API_PTR*outoptional数値型パラメータ値を受け取るJET_API_PTRポインタ。
szParamCHAR*outoptional文字列型パラメータ値を受け取るANSI文字列バッファ。
cbMaxDWORDinszParamバッファのバイトサイズ。

戻り値の型: INT

各言語での呼び出し定義

// ESENT.dll  (ANSI / -A)
#include <windows.h>

INT JetGetSystemParameterA(
    JET_INSTANCE instance,
    JET_SESID sesid,   // optional
    DWORD paramid,
    JET_API_PTR* plParam,   // optional
    CHAR* szParam,   // optional
    DWORD cbMax
);
[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetGetSystemParameterA(
    UIntPtr instance,   // JET_INSTANCE
    UIntPtr sesid,   // JET_SESID optional
    uint paramid,   // DWORD
    IntPtr plParam,   // JET_API_PTR* optional, out
    IntPtr szParam,   // CHAR* optional, out
    uint cbMax   // DWORD
);
<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetGetSystemParameterA(
    instance As UIntPtr,   ' JET_INSTANCE
    sesid As UIntPtr,   ' JET_SESID optional
    paramid As UInteger,   ' DWORD
    plParam As IntPtr,   ' JET_API_PTR* optional, out
    szParam As IntPtr,   ' CHAR* optional, out
    cbMax As UInteger   ' DWORD
) As Integer
End Function
' instance : JET_INSTANCE
' sesid : JET_SESID optional
' paramid : DWORD
' plParam : JET_API_PTR* optional, out
' szParam : CHAR* optional, out
' cbMax : DWORD
Declare PtrSafe Function JetGetSystemParameterA Lib "esent" ( _
    ByVal instance As LongPtr, _
    ByVal sesid As LongPtr, _
    ByVal paramid As Long, _
    ByVal plParam As LongPtr, _
    ByVal szParam As LongPtr, _
    ByVal cbMax As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

JetGetSystemParameterA = ctypes.windll.esent.JetGetSystemParameterA
JetGetSystemParameterA.restype = ctypes.c_int
JetGetSystemParameterA.argtypes = [
    ctypes.c_size_t,  # instance : JET_INSTANCE
    ctypes.c_size_t,  # sesid : JET_SESID optional
    wintypes.DWORD,  # paramid : DWORD
    ctypes.c_void_p,  # plParam : JET_API_PTR* optional, out
    ctypes.POINTER(ctypes.c_byte),  # szParam : CHAR* optional, out
    wintypes.DWORD,  # cbMax : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetGetSystemParameterA = esent.NewProc("JetGetSystemParameterA")
)

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

extern "esent" fn JetGetSystemParameterA(
    instance: usize, // JET_INSTANCE
    sesid: usize, // JET_SESID optional
    paramid: u32, // DWORD
    plParam: [*c]usize, // JET_API_PTR* optional, out
    szParam: [*c]i8, // CHAR* optional, out
    cbMax: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc JetGetSystemParameterA(
    instance: uint,  # JET_INSTANCE
    sesid: uint,  # JET_SESID optional
    paramid: uint32,  # DWORD
    plParam: ptr uint,  # JET_API_PTR* optional, out
    szParam: ptr int8,  # CHAR* optional, out
    cbMax: uint32  # DWORD
): int32 {.importc: "JetGetSystemParameterA", stdcall, dynlib: "ESENT.dll".}
pragma(lib, "esent");
extern(Windows)
int JetGetSystemParameterA(
    size_t instance,   // JET_INSTANCE
    size_t sesid,   // JET_SESID optional
    uint paramid,   // DWORD
    size_t* plParam,   // JET_API_PTR* optional, out
    byte* szParam,   // CHAR* optional, out
    uint cbMax   // DWORD
);
ccall((:JetGetSystemParameterA, "ESENT.dll"), stdcall, Int32,
      (Csize_t, Csize_t, UInt32, Ptr{Csize_t}, Ptr{Int8}, UInt32),
      instance, sesid, paramid, plParam, szParam, cbMax)
# instance : JET_INSTANCE -> Csize_t
# sesid : JET_SESID optional -> Csize_t
# paramid : DWORD -> UInt32
# plParam : JET_API_PTR* optional, out -> Ptr{Csize_t}
# szParam : CHAR* optional, out -> Ptr{Int8}
# cbMax : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetGetSystemParameterA(
    uintptr_t instance,
    uintptr_t sesid,
    uint32_t paramid,
    uintptr_t* plParam,
    int8_t* szParam,
    uint32_t cbMax);
]]
local esent = ffi.load("esent")
-- esent.JetGetSystemParameterA(instance, sesid, paramid, plParam, szParam, cbMax)
-- instance : JET_INSTANCE
-- sesid : JET_SESID optional
-- paramid : DWORD
-- plParam : JET_API_PTR* optional, out
-- szParam : CHAR* optional, out
-- cbMax : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetGetSystemParameterA = lib.func('__stdcall', 'JetGetSystemParameterA', 'int32_t', ['uintptr_t', 'uintptr_t', 'uint32_t', 'uintptr_t *', 'int8_t *', 'uint32_t']);
// JetGetSystemParameterA(instance, sesid, paramid, plParam, szParam, cbMax)
// instance : JET_INSTANCE -> 'uintptr_t'
// sesid : JET_SESID optional -> 'uintptr_t'
// paramid : DWORD -> 'uint32_t'
// plParam : JET_API_PTR* optional, out -> 'uintptr_t *'
// szParam : CHAR* optional, out -> 'int8_t *'
// cbMax : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetGetSystemParameterA: { parameters: ["usize", "usize", "u32", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.JetGetSystemParameterA(instance, sesid, paramid, plParam, szParam, cbMax)
// instance : JET_INSTANCE -> "usize"
// sesid : JET_SESID optional -> "usize"
// paramid : DWORD -> "u32"
// plParam : JET_API_PTR* optional, out -> "pointer"
// szParam : CHAR* optional, out -> "pointer"
// cbMax : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetGetSystemParameterA(
    size_t instance,
    size_t sesid,
    uint32_t paramid,
    size_t* plParam,
    int8_t* szParam,
    uint32_t cbMax);
C, "ESENT.dll");
// $ffi->JetGetSystemParameterA(instance, sesid, paramid, plParam, szParam, cbMax);
// instance : JET_INSTANCE
// sesid : JET_SESID optional
// paramid : DWORD
// plParam : JET_API_PTR* optional, out
// szParam : CHAR* optional, out
// cbMax : DWORD
// 構造体/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, W32APIOptions.ASCII_OPTIONS);
    int JetGetSystemParameterA(
        long instance,   // JET_INSTANCE
        long sesid,   // JET_SESID optional
        int paramid,   // DWORD
        LongByReference plParam,   // JET_API_PTR* optional, out
        byte[] szParam,   // CHAR* optional, out
        int cbMax   // DWORD
    );
}
@[Link("esent")]
lib LibESENT
  fun JetGetSystemParameterA = JetGetSystemParameterA(
    instance : LibC::SizeT,   # JET_INSTANCE
    sesid : LibC::SizeT,   # JET_SESID optional
    paramid : UInt32,   # DWORD
    plParam : LibC::SizeT*,   # JET_API_PTR* optional, out
    szParam : Int8*,   # CHAR* optional, out
    cbMax : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef JetGetSystemParameterANative = Int32 Function(UintPtr, UintPtr, Uint32, Pointer<UintPtr>, Pointer<Int8>, Uint32);
typedef JetGetSystemParameterADart = int Function(int, int, int, Pointer<UintPtr>, Pointer<Int8>, int);
final JetGetSystemParameterA = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetGetSystemParameterANative, JetGetSystemParameterADart>('JetGetSystemParameterA');
// instance : JET_INSTANCE -> UintPtr
// sesid : JET_SESID optional -> UintPtr
// paramid : DWORD -> Uint32
// plParam : JET_API_PTR* optional, out -> Pointer<UintPtr>
// szParam : CHAR* optional, out -> Pointer<Int8>
// cbMax : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetGetSystemParameterA(
  instance: NativeUInt;   // JET_INSTANCE
  sesid: NativeUInt;   // JET_SESID optional
  paramid: DWORD;   // DWORD
  plParam: Pointer;   // JET_API_PTR* optional, out
  szParam: Pointer;   // CHAR* optional, out
  cbMax: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetSystemParameterA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetGetSystemParameterA"
  c_JetGetSystemParameterA :: CUIntPtr -> CUIntPtr -> Word32 -> Ptr CUIntPtr -> Ptr Int8 -> Word32 -> IO Int32
-- instance : JET_INSTANCE -> CUIntPtr
-- sesid : JET_SESID optional -> CUIntPtr
-- paramid : DWORD -> Word32
-- plParam : JET_API_PTR* optional, out -> Ptr CUIntPtr
-- szParam : CHAR* optional, out -> Ptr Int8
-- cbMax : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetgetsystemparametera =
  foreign "JetGetSystemParameterA"
    (size_t @-> size_t @-> uint32_t @-> (ptr size_t) @-> (ptr int8_t) @-> uint32_t @-> returning int32_t)
(* instance : JET_INSTANCE -> size_t *)
(* sesid : JET_SESID optional -> size_t *)
(* paramid : DWORD -> uint32_t *)
(* plParam : JET_API_PTR* optional, out -> (ptr size_t) *)
(* szParam : CHAR* optional, out -> (ptr int8_t) *)
(* cbMax : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library esent (t "ESENT.dll"))
(cffi:use-foreign-library esent)

(cffi:defcfun ("JetGetSystemParameterA" jet-get-system-parameter-a :convention :stdcall) :int32
  (instance :uint64)   ; JET_INSTANCE
  (sesid :uint64)   ; JET_SESID optional
  (paramid :uint32)   ; DWORD
  (pl-param :pointer)   ; JET_API_PTR* optional, out
  (sz-param :pointer)   ; CHAR* optional, out
  (cb-max :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetGetSystemParameterA = Win32::API::More->new('ESENT',
    'int JetGetSystemParameterA(WPARAM instance, WPARAM sesid, DWORD paramid, LPVOID plParam, LPVOID szParam, DWORD cbMax)');
# my $ret = $JetGetSystemParameterA->Call($instance, $sesid, $paramid, $plParam, $szParam, $cbMax);
# instance : JET_INSTANCE -> WPARAM
# sesid : JET_SESID optional -> WPARAM
# paramid : DWORD -> DWORD
# plParam : JET_API_PTR* optional, out -> LPVOID
# szParam : CHAR* optional, out -> LPVOID
# cbMax : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い