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

JetGetLS

関数
ESEのテーブルまたはカーソルからローカルストレージ値を取得する。
DLLESENT.dll呼出規約winapi

シグネチャ

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

INT JetGetLS(
    JET_SESID sesid,
    JET_TABLEID tableid,
    JET_LS* pls,
    DWORD grbit
);

パラメーター

名前方向説明
sesidJET_SESIDin操作を行うセッションのJETセッションID。
tableidJET_TABLEIDinローカルストレージを取得する対象のテーブルまたはカーソルのID。
plsJET_LS*out取得したローカルストレージ値を受け取る出力ポインタ(JET_LS)。
grbitDWORDinJET_bitLSCursor/JET_bitLSTableなど対象とリセット動作を指定するフラグ。

戻り値の型: INT

各言語での呼び出し定義

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

INT JetGetLS(
    JET_SESID sesid,
    JET_TABLEID tableid,
    JET_LS* pls,
    DWORD grbit
);
[DllImport("ESENT.dll", ExactSpelling = true)]
static extern int JetGetLS(
    UIntPtr sesid,   // JET_SESID
    UIntPtr tableid,   // JET_TABLEID
    out UIntPtr pls,   // JET_LS* out
    uint grbit   // DWORD
);
<DllImport("ESENT.dll", ExactSpelling:=True)>
Public Shared Function JetGetLS(
    sesid As UIntPtr,   ' JET_SESID
    tableid As UIntPtr,   ' JET_TABLEID
    <Out> ByRef pls As UIntPtr,   ' JET_LS* out
    grbit As UInteger   ' DWORD
) As Integer
End Function
' sesid : JET_SESID
' tableid : JET_TABLEID
' pls : JET_LS* out
' grbit : DWORD
Declare PtrSafe Function JetGetLS Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal tableid As LongPtr, _
    ByRef pls As LongPtr, _
    ByVal grbit As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

JetGetLS = ctypes.windll.esent.JetGetLS
JetGetLS.restype = ctypes.c_int
JetGetLS.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    ctypes.c_void_p,  # pls : JET_LS* out
    wintypes.DWORD,  # grbit : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetGetLS = esent.NewProc("JetGetLS")
)

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

extern "esent" fn JetGetLS(
    sesid: usize, // JET_SESID
    tableid: usize, // JET_TABLEID
    pls: [*c]usize, // JET_LS* out
    grbit: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc JetGetLS(
    sesid: uint,  # JET_SESID
    tableid: uint,  # JET_TABLEID
    pls: ptr uint,  # JET_LS* out
    grbit: uint32  # DWORD
): int32 {.importc: "JetGetLS", stdcall, dynlib: "ESENT.dll".}
pragma(lib, "esent");
extern(Windows)
int JetGetLS(
    size_t sesid,   // JET_SESID
    size_t tableid,   // JET_TABLEID
    size_t* pls,   // JET_LS* out
    uint grbit   // DWORD
);
ccall((:JetGetLS, "ESENT.dll"), stdcall, Int32,
      (Csize_t, Csize_t, Ptr{Csize_t}, UInt32),
      sesid, tableid, pls, grbit)
# sesid : JET_SESID -> Csize_t
# tableid : JET_TABLEID -> Csize_t
# pls : JET_LS* out -> Ptr{Csize_t}
# grbit : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetGetLS(
    uintptr_t sesid,
    uintptr_t tableid,
    uintptr_t* pls,
    uint32_t grbit);
]]
local esent = ffi.load("esent")
-- esent.JetGetLS(sesid, tableid, pls, grbit)
-- sesid : JET_SESID
-- tableid : JET_TABLEID
-- pls : JET_LS* out
-- grbit : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetGetLS = lib.func('__stdcall', 'JetGetLS', 'int32_t', ['uintptr_t', 'uintptr_t', 'uintptr_t *', 'uint32_t']);
// JetGetLS(sesid, tableid, pls, grbit)
// sesid : JET_SESID -> 'uintptr_t'
// tableid : JET_TABLEID -> 'uintptr_t'
// pls : JET_LS* out -> 'uintptr_t *'
// grbit : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetGetLS: { parameters: ["usize", "usize", "pointer", "u32"], result: "i32" },
});
// lib.symbols.JetGetLS(sesid, tableid, pls, grbit)
// sesid : JET_SESID -> "usize"
// tableid : JET_TABLEID -> "usize"
// pls : JET_LS* out -> "pointer"
// grbit : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetGetLS(
    size_t sesid,
    size_t tableid,
    size_t* pls,
    uint32_t grbit);
C, "ESENT.dll");
// $ffi->JetGetLS(sesid, tableid, pls, grbit);
// sesid : JET_SESID
// tableid : JET_TABLEID
// pls : JET_LS* out
// grbit : 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);
    int JetGetLS(
        long sesid,   // JET_SESID
        long tableid,   // JET_TABLEID
        LongByReference pls,   // JET_LS* out
        int grbit   // DWORD
    );
}
@[Link("esent")]
lib LibESENT
  fun JetGetLS = JetGetLS(
    sesid : LibC::SizeT,   # JET_SESID
    tableid : LibC::SizeT,   # JET_TABLEID
    pls : LibC::SizeT*,   # JET_LS* out
    grbit : 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 JetGetLSNative = Int32 Function(UintPtr, UintPtr, Pointer<UintPtr>, Uint32);
typedef JetGetLSDart = int Function(int, int, Pointer<UintPtr>, int);
final JetGetLS = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetGetLSNative, JetGetLSDart>('JetGetLS');
// sesid : JET_SESID -> UintPtr
// tableid : JET_TABLEID -> UintPtr
// pls : JET_LS* out -> Pointer<UintPtr>
// grbit : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetGetLS(
  sesid: NativeUInt;   // JET_SESID
  tableid: NativeUInt;   // JET_TABLEID
  pls: Pointer;   // JET_LS* out
  grbit: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetLS';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetGetLS"
  c_JetGetLS :: CUIntPtr -> CUIntPtr -> Ptr CUIntPtr -> Word32 -> IO Int32
-- sesid : JET_SESID -> CUIntPtr
-- tableid : JET_TABLEID -> CUIntPtr
-- pls : JET_LS* out -> Ptr CUIntPtr
-- grbit : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetgetls =
  foreign "JetGetLS"
    (size_t @-> size_t @-> (ptr size_t) @-> uint32_t @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* tableid : JET_TABLEID -> size_t *)
(* pls : JET_LS* out -> (ptr size_t) *)
(* grbit : 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 ("JetGetLS" jet-get-ls :convention :stdcall) :int32
  (sesid :uint64)   ; JET_SESID
  (tableid :uint64)   ; JET_TABLEID
  (pls :pointer)   ; JET_LS* out
  (grbit :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetGetLS = Win32::API::More->new('ESENT',
    'int JetGetLS(WPARAM sesid, WPARAM tableid, LPVOID pls, DWORD grbit)');
# my $ret = $JetGetLS->Call($sesid, $tableid, $pls, $grbit);
# sesid : JET_SESID -> WPARAM
# tableid : JET_TABLEID -> WPARAM
# pls : JET_LS* out -> LPVOID
# grbit : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。