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

JetSetSystemParameterW

関数
ESEのシステムパラメーターを設定する。
DLLESENT.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

// ESENT.dll  (Unicode / -W)
#include <windows.h>

INT JetSetSystemParameterW(
    JET_INSTANCE* pinstance,   // optional
    JET_SESID sesid,   // optional
    DWORD paramid,
    JET_API_PTR lParam,   // optional
    WORD* szParam   // optional
);

パラメーター

名前方向説明
pinstanceJET_INSTANCE*inoutoptional対象インスタンスハンドルへのポインタ。グローバル設定時はNULL指定可。
sesidJET_SESIDinoptional操作に使用するセッションID。不要な場合はJET_sesidNilを指定する。
paramidDWORDin設定するシステムパラメータの識別子(JET_param系定数)。
lParamJET_API_PTRinoptional数値型パラメータの設定値(JET_API_PTR)。
szParamWORD*inoptional文字列型パラメータの設定値を指すワイド文字列(WORD*)。NULL可。

戻り値の型: INT

各言語での呼び出し定義

// ESENT.dll  (Unicode / -W)
#include <windows.h>

INT JetSetSystemParameterW(
    JET_INSTANCE* pinstance,   // optional
    JET_SESID sesid,   // optional
    DWORD paramid,
    JET_API_PTR lParam,   // optional
    WORD* szParam   // optional
);
[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetSetSystemParameterW(
    IntPtr pinstance,   // JET_INSTANCE* optional, in/out
    UIntPtr sesid,   // JET_SESID optional
    uint paramid,   // DWORD
    UIntPtr lParam,   // JET_API_PTR optional
    IntPtr szParam   // WORD* optional
);
<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetSetSystemParameterW(
    pinstance As IntPtr,   ' JET_INSTANCE* optional, in/out
    sesid As UIntPtr,   ' JET_SESID optional
    paramid As UInteger,   ' DWORD
    lParam As UIntPtr,   ' JET_API_PTR optional
    szParam As IntPtr   ' WORD* optional
) As Integer
End Function
' pinstance : JET_INSTANCE* optional, in/out
' sesid : JET_SESID optional
' paramid : DWORD
' lParam : JET_API_PTR optional
' szParam : WORD* optional
Declare PtrSafe Function JetSetSystemParameterW Lib "esent" ( _
    ByVal pinstance As LongPtr, _
    ByVal sesid As LongPtr, _
    ByVal paramid As Long, _
    ByVal lParam As LongPtr, _
    ByVal szParam As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

JetSetSystemParameterW = ctypes.windll.esent.JetSetSystemParameterW
JetSetSystemParameterW.restype = ctypes.c_int
JetSetSystemParameterW.argtypes = [
    ctypes.c_void_p,  # pinstance : JET_INSTANCE* optional, in/out
    ctypes.c_size_t,  # sesid : JET_SESID optional
    wintypes.DWORD,  # paramid : DWORD
    ctypes.c_size_t,  # lParam : JET_API_PTR optional
    ctypes.POINTER(ctypes.c_ushort),  # szParam : WORD* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetSetSystemParameterW = esent.NewProc("JetSetSystemParameterW")
)

// pinstance (JET_INSTANCE* optional, in/out), sesid (JET_SESID optional), paramid (DWORD), lParam (JET_API_PTR optional), szParam (WORD* optional)
r1, _, err := procJetSetSystemParameterW.Call(
	uintptr(pinstance),
	uintptr(sesid),
	uintptr(paramid),
	uintptr(lParam),
	uintptr(szParam),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function JetSetSystemParameterW(
  pinstance: Pointer;   // JET_INSTANCE* optional, in/out
  sesid: NativeUInt;   // JET_SESID optional
  paramid: DWORD;   // DWORD
  lParam: NativeUInt;   // JET_API_PTR optional
  szParam: Pointer   // WORD* optional
): Integer; stdcall;
  external 'ESENT.dll' name 'JetSetSystemParameterW';
result := DllCall("ESENT\JetSetSystemParameterW"
    , "Ptr", pinstance   ; JET_INSTANCE* optional, in/out
    , "UPtr", sesid   ; JET_SESID optional
    , "UInt", paramid   ; DWORD
    , "UPtr", lParam   ; JET_API_PTR optional
    , "Ptr", szParam   ; WORD* optional
    , "Int")   ; return: INT
●JetSetSystemParameterW(pinstance, sesid, paramid, lParam, szParam) = DLL("ESENT.dll", "int JetSetSystemParameterW(void*, int, dword, int, void*)")
# 呼び出し: JetSetSystemParameterW(pinstance, sesid, paramid, lParam, szParam)
# pinstance : JET_INSTANCE* optional, in/out -> "void*"
# sesid : JET_SESID optional -> "int"
# paramid : DWORD -> "dword"
# lParam : JET_API_PTR optional -> "int"
# szParam : WORD* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "esent" fn JetSetSystemParameterW(
    pinstance: [*c]usize, // JET_INSTANCE* optional, in/out
    sesid: usize, // JET_SESID optional
    paramid: u32, // DWORD
    lParam: usize, // JET_API_PTR optional
    szParam: [*c]u16 // WORD* optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc JetSetSystemParameterW(
    pinstance: ptr uint,  # JET_INSTANCE* optional, in/out
    sesid: uint,  # JET_SESID optional
    paramid: uint32,  # DWORD
    lParam: uint,  # JET_API_PTR optional
    szParam: ptr uint16  # WORD* optional
): int32 {.importc: "JetSetSystemParameterW", stdcall, dynlib: "ESENT.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "esent");
extern(Windows)
int JetSetSystemParameterW(
    size_t* pinstance,   // JET_INSTANCE* optional, in/out
    size_t sesid,   // JET_SESID optional
    uint paramid,   // DWORD
    size_t lParam,   // JET_API_PTR optional
    ushort* szParam   // WORD* optional
);
ccall((:JetSetSystemParameterW, "ESENT.dll"), stdcall, Int32,
      (Ptr{Csize_t}, Csize_t, UInt32, Csize_t, Ptr{UInt16}),
      pinstance, sesid, paramid, lParam, szParam)
# pinstance : JET_INSTANCE* optional, in/out -> Ptr{Csize_t}
# sesid : JET_SESID optional -> Csize_t
# paramid : DWORD -> UInt32
# lParam : JET_API_PTR optional -> Csize_t
# szParam : WORD* optional -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetSetSystemParameterW(
    uintptr_t* pinstance,
    uintptr_t sesid,
    uint32_t paramid,
    uintptr_t lParam,
    uint16_t* szParam);
]]
local esent = ffi.load("esent")
-- esent.JetSetSystemParameterW(pinstance, sesid, paramid, lParam, szParam)
-- pinstance : JET_INSTANCE* optional, in/out
-- sesid : JET_SESID optional
-- paramid : DWORD
-- lParam : JET_API_PTR optional
-- szParam : WORD* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetSetSystemParameterW = lib.func('__stdcall', 'JetSetSystemParameterW', 'int32_t', ['uintptr_t *', 'uintptr_t', 'uint32_t', 'uintptr_t', 'uint16_t *']);
// JetSetSystemParameterW(pinstance, sesid, paramid, lParam, szParam)
// pinstance : JET_INSTANCE* optional, in/out -> 'uintptr_t *'
// sesid : JET_SESID optional -> 'uintptr_t'
// paramid : DWORD -> 'uint32_t'
// lParam : JET_API_PTR optional -> 'uintptr_t'
// szParam : WORD* optional -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetSetSystemParameterW: { parameters: ["pointer", "usize", "u32", "usize", "pointer"], result: "i32" },
});
// lib.symbols.JetSetSystemParameterW(pinstance, sesid, paramid, lParam, szParam)
// pinstance : JET_INSTANCE* optional, in/out -> "pointer"
// sesid : JET_SESID optional -> "usize"
// paramid : DWORD -> "u32"
// lParam : JET_API_PTR optional -> "usize"
// szParam : WORD* optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetSetSystemParameterW(
    size_t* pinstance,
    size_t sesid,
    uint32_t paramid,
    size_t lParam,
    uint16_t* szParam);
C, "ESENT.dll");
// $ffi->JetSetSystemParameterW(pinstance, sesid, paramid, lParam, szParam);
// pinstance : JET_INSTANCE* optional, in/out
// sesid : JET_SESID optional
// paramid : DWORD
// lParam : JET_API_PTR optional
// szParam : WORD* optional
// 構造体/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.UNICODE_OPTIONS);
    int JetSetSystemParameterW(
        LongByReference pinstance,   // JET_INSTANCE* optional, in/out
        long sesid,   // JET_SESID optional
        int paramid,   // DWORD
        long lParam,   // JET_API_PTR optional
        ShortByReference szParam   // WORD* optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("esent")]
lib LibESENT
  fun JetSetSystemParameterW = JetSetSystemParameterW(
    pinstance : LibC::SizeT*,   # JET_INSTANCE* optional, in/out
    sesid : LibC::SizeT,   # JET_SESID optional
    paramid : UInt32,   # DWORD
    lParam : LibC::SizeT,   # JET_API_PTR optional
    szParam : UInt16*   # WORD* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

foreign import stdcall safe "JetSetSystemParameterW"
  c_JetSetSystemParameterW :: Ptr CUIntPtr -> CUIntPtr -> Word32 -> CUIntPtr -> Ptr Word16 -> IO Int32
-- pinstance : JET_INSTANCE* optional, in/out -> Ptr CUIntPtr
-- sesid : JET_SESID optional -> CUIntPtr
-- paramid : DWORD -> Word32
-- lParam : JET_API_PTR optional -> CUIntPtr
-- szParam : WORD* optional -> Ptr Word16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetsetsystemparameterw =
  foreign "JetSetSystemParameterW"
    ((ptr size_t) @-> size_t @-> uint32_t @-> size_t @-> (ptr uint16_t) @-> returning int32_t)
(* pinstance : JET_INSTANCE* optional, in/out -> (ptr size_t) *)
(* sesid : JET_SESID optional -> size_t *)
(* paramid : DWORD -> uint32_t *)
(* lParam : JET_API_PTR optional -> size_t *)
(* szParam : WORD* optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library esent (t "ESENT.dll"))
(cffi:use-foreign-library esent)

(cffi:defcfun ("JetSetSystemParameterW" jet-set-system-parameter-w :convention :stdcall) :int32
  (pinstance :pointer)   ; JET_INSTANCE* optional, in/out
  (sesid :uint64)   ; JET_SESID optional
  (paramid :uint32)   ; DWORD
  (l-param :uint64)   ; JET_API_PTR optional
  (sz-param :pointer))   ; WORD* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetSetSystemParameterW = Win32::API::More->new('ESENT',
    'int JetSetSystemParameterW(LPVOID pinstance, WPARAM sesid, DWORD paramid, WPARAM lParam, LPVOID szParam)');
# my $ret = $JetSetSystemParameterW->Call($pinstance, $sesid, $paramid, $lParam, $szParam);
# pinstance : JET_INSTANCE* optional, in/out -> LPVOID
# sesid : JET_SESID optional -> WPARAM
# paramid : DWORD -> DWORD
# lParam : JET_API_PTR optional -> WPARAM
# szParam : WORD* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い