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

JetRetrieveKey

関数
現在のレコードのインデックスキー値を取得する。
DLLESENT.dll呼出規約winapi

シグネチャ

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

INT JetRetrieveKey(
    JET_SESID sesid,
    JET_TABLEID tableid,
    void* pvKey,   // optional
    DWORD cbMax,
    DWORD* pcbActual,   // optional
    DWORD grbit
);

パラメーター

名前方向説明
sesidJET_SESIDinキー取得を行うセッションのJET_SESIDハンドル。
tableidJET_TABLEIDin現在のインデックスキーを取得する対象テーブルのカーソルハンドル。
pvKeyvoid*outoptional取得したキーデータを受け取る出力バッファポインタ。NULLで必要サイズ照会が可能である。
cbMaxDWORDinpvKeyバッファのサイズをバイト単位で指定する値。
pcbActualDWORD*outoptionalキーの実バイト長を受け取る出力ポインタ。NULL可。
grbitDWORDin取得動作を制御するビットフラグ。JET_bitRetrieveCopyで構築中キーバッファから取得を指定する。

戻り値の型: INT

各言語での呼び出し定義

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

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

JetRetrieveKey = ctypes.windll.esent.JetRetrieveKey
JetRetrieveKey.restype = ctypes.c_int
JetRetrieveKey.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    ctypes.POINTER(None),  # pvKey : void* optional, out
    wintypes.DWORD,  # cbMax : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbActual : DWORD* optional, out
    wintypes.DWORD,  # grbit : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetRetrieveKey = esent.NewProc("JetRetrieveKey")
)

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

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

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

let jetretrievekey =
  foreign "JetRetrieveKey"
    (size_t @-> size_t @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> uint32_t @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* tableid : JET_TABLEID -> size_t *)
(* pvKey : void* optional, out -> (ptr void) *)
(* cbMax : DWORD -> uint32_t *)
(* pcbActual : DWORD* optional, out -> (ptr uint32_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 ("JetRetrieveKey" jet-retrieve-key :convention :stdcall) :int32
  (sesid :uint64)   ; JET_SESID
  (tableid :uint64)   ; JET_TABLEID
  (pv-key :pointer)   ; void* optional, out
  (cb-max :uint32)   ; DWORD
  (pcb-actual :pointer)   ; DWORD* optional, out
  (grbit :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetRetrieveKey = Win32::API::More->new('ESENT',
    'int JetRetrieveKey(WPARAM sesid, WPARAM tableid, LPVOID pvKey, DWORD cbMax, LPVOID pcbActual, DWORD grbit)');
# my $ret = $JetRetrieveKey->Call($sesid, $tableid, $pvKey, $cbMax, $pcbActual, $grbit);
# sesid : JET_SESID -> WPARAM
# tableid : JET_TABLEID -> WPARAM
# pvKey : void* optional, out -> LPVOID
# cbMax : DWORD -> DWORD
# pcbActual : DWORD* optional, out -> LPVOID
# grbit : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。