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

JetPrereadKeys

関数
指定したキーのレコードを事前に先読みしてキャッシュする。
DLLESENT.dll呼出規約winapi

シグネチャ

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

INT JetPrereadKeys(
    JET_SESID sesid,
    JET_TABLEID tableid,
    void** rgpvKeys,
    const DWORD* rgcbKeys,
    INT ckeys,
    INT* pckeysPreread,   // optional
    DWORD grbit
);

パラメーター

名前方向説明
sesidJET_SESIDinキーの先読みを行うセッションのJET_SESIDハンドル。
tableidJET_TABLEIDin先読み対象のテーブルカーソルハンドル。
rgpvKeysvoid**in先読みする各キーデータへのポインタ配列(void**)。
rgcbKeysDWORD*inrgpvKeysの各キーのバイト長を格納したDWORD配列のポインタ。
ckeysINTin先読みするキーの個数を指定する値。
pckeysPrereadINT*outoptional実際に先読みされたキー数を受け取る出力ポインタ。NULL可。
grbitDWORDin先読み動作を制御するビットフラグ。JET_bitPrereadForward等で方向を指定する。

戻り値の型: INT

各言語での呼び出し定義

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

INT JetPrereadKeys(
    JET_SESID sesid,
    JET_TABLEID tableid,
    void** rgpvKeys,
    const DWORD* rgcbKeys,
    INT ckeys,
    INT* pckeysPreread,   // optional
    DWORD grbit
);
[DllImport("ESENT.dll", ExactSpelling = true)]
static extern int JetPrereadKeys(
    UIntPtr sesid,   // JET_SESID
    UIntPtr tableid,   // JET_TABLEID
    IntPtr rgpvKeys,   // void**
    ref uint rgcbKeys,   // DWORD*
    int ckeys,   // INT
    IntPtr pckeysPreread,   // INT* optional, out
    uint grbit   // DWORD
);
<DllImport("ESENT.dll", ExactSpelling:=True)>
Public Shared Function JetPrereadKeys(
    sesid As UIntPtr,   ' JET_SESID
    tableid As UIntPtr,   ' JET_TABLEID
    rgpvKeys As IntPtr,   ' void**
    ByRef rgcbKeys As UInteger,   ' DWORD*
    ckeys As Integer,   ' INT
    pckeysPreread As IntPtr,   ' INT* optional, out
    grbit As UInteger   ' DWORD
) As Integer
End Function
' sesid : JET_SESID
' tableid : JET_TABLEID
' rgpvKeys : void**
' rgcbKeys : DWORD*
' ckeys : INT
' pckeysPreread : INT* optional, out
' grbit : DWORD
Declare PtrSafe Function JetPrereadKeys Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal tableid As LongPtr, _
    ByVal rgpvKeys As LongPtr, _
    ByRef rgcbKeys As Long, _
    ByVal ckeys As Long, _
    ByVal pckeysPreread 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

JetPrereadKeys = ctypes.windll.esent.JetPrereadKeys
JetPrereadKeys.restype = ctypes.c_int
JetPrereadKeys.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    ctypes.c_void_p,  # rgpvKeys : void**
    ctypes.POINTER(wintypes.DWORD),  # rgcbKeys : DWORD*
    ctypes.c_int,  # ckeys : INT
    ctypes.POINTER(ctypes.c_int),  # pckeysPreread : INT* optional, out
    wintypes.DWORD,  # grbit : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetPrereadKeys = esent.NewProc("JetPrereadKeys")
)

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

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

foreign import stdcall safe "JetPrereadKeys"
  c_JetPrereadKeys :: CUIntPtr -> CUIntPtr -> Ptr () -> Ptr Word32 -> Int32 -> Ptr Int32 -> Word32 -> IO Int32
-- sesid : JET_SESID -> CUIntPtr
-- tableid : JET_TABLEID -> CUIntPtr
-- rgpvKeys : void** -> Ptr ()
-- rgcbKeys : DWORD* -> Ptr Word32
-- ckeys : INT -> Int32
-- pckeysPreread : INT* optional, out -> Ptr Int32
-- grbit : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetprereadkeys =
  foreign "JetPrereadKeys"
    (size_t @-> size_t @-> (ptr void) @-> (ptr uint32_t) @-> int32_t @-> (ptr int32_t) @-> uint32_t @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* tableid : JET_TABLEID -> size_t *)
(* rgpvKeys : void** -> (ptr void) *)
(* rgcbKeys : DWORD* -> (ptr uint32_t) *)
(* ckeys : INT -> int32_t *)
(* pckeysPreread : INT* optional, out -> (ptr int32_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 ("JetPrereadKeys" jet-preread-keys :convention :stdcall) :int32
  (sesid :uint64)   ; JET_SESID
  (tableid :uint64)   ; JET_TABLEID
  (rgpv-keys :pointer)   ; void**
  (rgcb-keys :pointer)   ; DWORD*
  (ckeys :int32)   ; INT
  (pckeys-preread :pointer)   ; INT* optional, out
  (grbit :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetPrereadKeys = Win32::API::More->new('ESENT',
    'int JetPrereadKeys(WPARAM sesid, WPARAM tableid, LPVOID rgpvKeys, LPVOID rgcbKeys, int ckeys, LPVOID pckeysPreread, DWORD grbit)');
# my $ret = $JetPrereadKeys->Call($sesid, $tableid, $rgpvKeys, $rgcbKeys, $ckeys, $pckeysPreread, $grbit);
# sesid : JET_SESID -> WPARAM
# tableid : JET_TABLEID -> WPARAM
# rgpvKeys : void** -> LPVOID
# rgcbKeys : DWORD* -> LPVOID
# ckeys : INT -> int
# pckeysPreread : INT* optional, out -> LPVOID
# grbit : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。