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
tableidJET_TABLEIDin
pvKeyvoid*outoptional
cbMaxDWORDin
pcbActualDWORD*outoptional
grbitDWORDin

戻り値の型: 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)。