JetMakeKey
関数シグネチャ
// ESENT.dll
#include <windows.h>
INT JetMakeKey(
JET_SESID sesid,
JET_TABLEID tableid,
void* pvData, // optional
DWORD cbData,
DWORD grbit
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| sesid | JET_SESID | in | キー構築を行うセッションのJET_SESIDハンドル。 |
| tableid | JET_TABLEID | in | 検索キーを構築する対象テーブルのカーソルハンドル。 |
| pvData | void* | inoptional | キー列に対応するデータを格納したバッファポインタ。NULLでNull値キーを構成する。 |
| cbData | DWORD | in | pvDataのデータ長をバイト単位で指定する値。 |
| grbit | DWORD | in | キー構築動作を制御するビットフラグ。JET_bitNewKeyで新規キー開始、ワイルドカード等を指定する。 |
戻り値の型: INT
公式ドキュメント
JetMakeKey 関数は、キー列の値に対する単純な検索条件によってインデックス内の一連のエントリを検索するために使用できる検索キーを構築します。検索キーはカーソルの固有のプロパティの 1 つでもあり、JetSeek 操作および JetSetIndexRange 操作が、そのカーソルの現在のインデックス上でこれらの検索条件に一致するインデックスエントリを見つけるために使用します。完全な検索キーは一連の JetMakeKey 呼び出しによって構築され、各呼び出しはカーソルの現在のインデックスの次のキー列に対する列値を設定するために使用されます。また、JetRetrieveKey を使用してカーソルから取得した、以前に構築された検索キーを読み込むこともできます。
戻り値
この関数は、次のいずれかの戻り値コードとともに JET_ERR データ型を返します。発生する可能性のある ESE エラーの詳細については、Extensible Storage Engine Errors および Error Handling Parameters を参照してください。
戻り値コード |
説明 |
|---|---|
JET_errSuccess |
操作は成功しました。 |
JET_errClientRequestToStopJetService |
JetStopService の呼び出しによって、セッションに関連付けられたインスタンス上のすべての動作が停止したため、操作を完了できません。 |
JET_errIndexTuplesKeyTooSmall |
現在のインデックスがタプルインデックスであり、その最小タプルサイズが指定された列データよりも大きかったため、指定された列データは現在のインデックスに対する有効なキーを構築するには小さすぎました。タプルインデックスの詳細については、JetCreateIndex を参照してください。このエラーは Windows XP 以降のリリースでのみ返されます。 |
JET_errInstanceUnavailable |
セッションに関連付けられたインスタンスで、データの整合性を保護するためにすべてのデータへのアクセスを取り消す必要がある致命的なエラーが発生したため、操作を完了できません。このエラーは Windows XP 以降のリリースでのみ返されます。 |
JET_errInvalidBufferSize |
指定された列データが、列定義で必要とされるサイズと一致しませんでした。これは、列のデータ型が本質的に特定のサイズである場合に発生することがあります。また、列のデータ型が本質的に特定のサイズではないものの、列の定義で固定長として宣言されている場合にも発生することがあります。ただし例外として、固定長のテキスト列に対して指定したデータが少なすぎる場合は、不足分が自動的にスペースで埋められるため、このエラーは発生しません。2 つ目の例外として、固定長のバイナリ列に対して指定したデータが少なすぎる場合は、不足分が自動的にゼロで埋められるため、このエラーは発生しません。 |
JET_errInvalidgrbit |
要求されたオプションの 1 つが無効であるか、不正な方法で使用されたか、または実装されていません。JetMakeKey では、次の場合にこのエラーが発生することがあります。
|
JET_errInvalidParameter |
指定されたパラメーターの 1 つに、予期しない値、または別のパラメーターの値と組み合わせたときに意味をなさない値が含まれていました。 JetMakeKey では、JET_bitNormalizedKey が指定され、入力バッファーに指定された値が有効な検索キーとしては大きすぎた場合に、このエラーが発生することがあります。 |
JET_errKeyIsMade |
現在のインデックスのすべてのキー列に対して既に列データが指定されているため、JetMakeKey に指定された列データは拒否されました。これは 3 とおりの場合に発生します。1 つ目は、現在のインデックスの各キー列に対して列データが指定された場合です。2 つ目は、少なくとも 1 つのキー列に対して列データが指定され、最後の呼び出しでワイルドカードオプションが選択された場合です。3 つ目は、すべてのキー列を網羅する、以前に構築された検索キーが JET_bitNormalizedKey を使用して指定された場合です。 |
JET_errKeyNotMade |
カーソルに現在の検索キーがありません。これは JetMakeKey で、JET_bitNewKey が指定されておらず、かつ事前の JetMakeKey の呼び出しによってこのカーソルの検索キーが構築されていない場合に発生します。検索キーは、JetMove 以外のカーソルに対するナビゲーション API を事前に呼び出すと削除されます。 |
JET_errNoCurrentIndex |
カーソルに現在のインデックスがありません。これは JetMakeKey で、カーソルがテーブルのクラスター化インデックス上にあり、主インデックスが定義されておらず、かつ JET_bitNormalizedKey が指定されていない場合に発生します。キー列を持たないインデックス上にカーソルがある場合は、以前に構築された検索キーを指定しない限り、検索キーを構築することはできません。 |
JET_errNotInitialized |
セッションに関連付けられたインスタンスがまだ初期化されていないため、操作を完了できません。 |
JET_errRestoreInProgress |
セッションに関連付けられたインスタンスで復元操作が進行中のため、操作を完了できません。 |
JET_errSessionSharingViolation |
同じセッションを同時に複数のスレッドで使用することはできません。このエラーは Windows XP 以降のリリースでのみ返されます。 |
JET_errTermInProgress |
セッションに関連付けられたインスタンスがシャットダウン中のため、操作を完了できません。 |
成功した場合、JET_bitNormalizedKey と JET_bitNewKey のいずれも指定されていなければ、現在のインデックスのもう 1 つのキー列に対する検索条件が検索キーに追加されます。JET_bitNormalizedKey が指定されず JET_bitNewKey が指定された場合は、既存の検索キーは破棄され、現在のインデックスの最初のキー列に対する検索条件によって新しい検索キーが構築されます。JET_bitNormalizedKey が指定された場合は、既存の検索キーは破棄され、入力バッファーから新しい検索キーが読み込まれます。いずれの場合も、データベースの状態は変化しません。
失敗した場合、JET_bitNormalizedKey または JET_bitNewKey が指定されていたときは、検索キーの状態は未定義です。JET_bitNormalizedKey と JET_bitNewKey のいずれも指定されていなかった場合は、検索キーの状態は変化しません。いずれの場合も、データベースの状態は変化しません。
解説
キーは不透明なデータの塊として扱う必要があります。このデータの内部構造を利用しようとしてはいけません。ただし、すべての ESENT キーについては、次のことが分かっています。
キーどうしは memcmp を使用して比較でき、インデックスエントリの取得元となったテーブル上の、元のインデックスにおける相対的な順序を判断できます。
異なるインデックスのインデックスエントリのキーどうしを比較しても意味がありません。
Windows Vista より前では、キーの長さは常に JET_cbKeyMost (255) バイト以下です。Windows Vista 以降のリリースでは、キーはより大きくなることがあります。キーの最大サイズは JET_paramKeyMost の現在の値と等しくなります。
ワイルドカードオプションを使用した場合、検索キーは 1 バイト長くなることがあります。その場合、検索キーは Windows Vista より前のリリースでは最大 JET_cbLimitKeyMost (256) バイト、Windows Vista 以降のリリースでは最大 JET_paramKeyMost + 1 バイトになります。
この最大キーサイズには、非常に重要な影響があります。インデックスエントリの列値が大きく、そのインデックスに対して生成されるキーがこの最大サイズを超えてしまう場合、そのキーは最大サイズで暗黙のうちに切り捨てられます。これによって次の 2 つの影響が生じます。
一意インデックスのエントリでは、本来は一意であるはずのエントリが重複と判定される原因になります。
すべてのインデックスのエントリにおいて、キーの切り捨てにより、本来は指定された検索キーの検索条件に一致しないはずのインデックスエントリが一致と判定される原因になります。
アプリケーションはこの切り捨てを想定し、回避するか、その影響を補う必要があります。Windows Vista では、アプリケーションがキーの切り捨てを防ぎやすくするために、新しいインデックスフラグ JET_bitIndexDisallowTruncation が追加されました。このインデックスオプションの詳細については、JET_INDEXCREATE 構造体を参照してください。
要件
| 要件 | 値 |
|---|---|
クライアント |
Windows Vista、Windows XP、または Windows 2000 Professional が必要です。 |
サーバー |
Windows Server 2008、Windows Server 2003、または Windows 2000 Server が必要です。 |
ヘッダー |
Esent.h で宣言されています。 |
ライブラリ |
ESENT.lib を使用します。 |
DLL |
ESENT.dll が必要です。 |
関連項目
JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JetCreateIndex
JetRetrieveKey
JetSeek
JetSetIndexRange
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)
各言語での呼び出し定義
// ESENT.dll
#include <windows.h>
INT JetMakeKey(
JET_SESID sesid,
JET_TABLEID tableid,
void* pvData, // optional
DWORD cbData,
DWORD grbit
);[DllImport("ESENT.dll", ExactSpelling = true)]
static extern int JetMakeKey(
UIntPtr sesid, // JET_SESID
UIntPtr tableid, // JET_TABLEID
IntPtr pvData, // void* optional
uint cbData, // DWORD
uint grbit // DWORD
);<DllImport("ESENT.dll", ExactSpelling:=True)>
Public Shared Function JetMakeKey(
sesid As UIntPtr, ' JET_SESID
tableid As UIntPtr, ' JET_TABLEID
pvData As IntPtr, ' void* optional
cbData As UInteger, ' DWORD
grbit As UInteger ' DWORD
) As Integer
End Function' sesid : JET_SESID
' tableid : JET_TABLEID
' pvData : void* optional
' cbData : DWORD
' grbit : DWORD
Declare PtrSafe Function JetMakeKey Lib "esent" ( _
ByVal sesid As LongPtr, _
ByVal tableid As LongPtr, _
ByVal pvData As LongPtr, _
ByVal cbData As Long, _
ByVal grbit As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
JetMakeKey = ctypes.windll.esent.JetMakeKey
JetMakeKey.restype = ctypes.c_int
JetMakeKey.argtypes = [
ctypes.c_size_t, # sesid : JET_SESID
ctypes.c_size_t, # tableid : JET_TABLEID
ctypes.POINTER(None), # pvData : void* optional
wintypes.DWORD, # cbData : DWORD
wintypes.DWORD, # grbit : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ESENT.dll')
JetMakeKey = Fiddle::Function.new(
lib['JetMakeKey'],
[
Fiddle::TYPE_UINTPTR_T, # sesid : JET_SESID
Fiddle::TYPE_UINTPTR_T, # tableid : JET_TABLEID
Fiddle::TYPE_VOIDP, # pvData : void* optional
-Fiddle::TYPE_INT, # cbData : DWORD
-Fiddle::TYPE_INT, # grbit : DWORD
],
Fiddle::TYPE_INT)#[link(name = "esent")]
extern "system" {
fn JetMakeKey(
sesid: usize, // JET_SESID
tableid: usize, // JET_TABLEID
pvData: *mut (), // void* optional
cbData: u32, // DWORD
grbit: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("ESENT.dll")]
public static extern int JetMakeKey(UIntPtr sesid, UIntPtr tableid, IntPtr pvData, uint cbData, uint grbit);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetMakeKey' -Namespace Win32 -PassThru
# $api::JetMakeKey(sesid, tableid, pvData, cbData, grbit)#uselib "ESENT.dll"
#func global JetMakeKey "JetMakeKey" sptr, sptr, sptr, sptr, sptr
; JetMakeKey sesid, tableid, pvData, cbData, grbit ; 戻り値は stat
; sesid : JET_SESID -> "sptr"
; tableid : JET_TABLEID -> "sptr"
; pvData : void* optional -> "sptr"
; cbData : DWORD -> "sptr"
; grbit : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ESENT.dll"
#cfunc global JetMakeKey "JetMakeKey" sptr, sptr, sptr, int, int
; res = JetMakeKey(sesid, tableid, pvData, cbData, grbit)
; sesid : JET_SESID -> "sptr"
; tableid : JET_TABLEID -> "sptr"
; pvData : void* optional -> "sptr"
; cbData : DWORD -> "int"
; grbit : DWORD -> "int"; INT JetMakeKey(JET_SESID sesid, JET_TABLEID tableid, void* pvData, DWORD cbData, DWORD grbit)
#uselib "ESENT.dll"
#cfunc global JetMakeKey "JetMakeKey" intptr, intptr, intptr, int, int
; res = JetMakeKey(sesid, tableid, pvData, cbData, grbit)
; sesid : JET_SESID -> "intptr"
; tableid : JET_TABLEID -> "intptr"
; pvData : void* optional -> "intptr"
; cbData : DWORD -> "int"
; grbit : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
esent = windows.NewLazySystemDLL("ESENT.dll")
procJetMakeKey = esent.NewProc("JetMakeKey")
)
// sesid (JET_SESID), tableid (JET_TABLEID), pvData (void* optional), cbData (DWORD), grbit (DWORD)
r1, _, err := procJetMakeKey.Call(
uintptr(sesid),
uintptr(tableid),
uintptr(pvData),
uintptr(cbData),
uintptr(grbit),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction JetMakeKey(
sesid: NativeUInt; // JET_SESID
tableid: NativeUInt; // JET_TABLEID
pvData: Pointer; // void* optional
cbData: DWORD; // DWORD
grbit: DWORD // DWORD
): Integer; stdcall;
external 'ESENT.dll' name 'JetMakeKey';result := DllCall("ESENT\JetMakeKey"
, "UPtr", sesid ; JET_SESID
, "UPtr", tableid ; JET_TABLEID
, "Ptr", pvData ; void* optional
, "UInt", cbData ; DWORD
, "UInt", grbit ; DWORD
, "Int") ; return: INT●JetMakeKey(sesid, tableid, pvData, cbData, grbit) = DLL("ESENT.dll", "int JetMakeKey(int, int, void*, dword, dword)")
# 呼び出し: JetMakeKey(sesid, tableid, pvData, cbData, grbit)
# sesid : JET_SESID -> "int"
# tableid : JET_TABLEID -> "int"
# pvData : void* optional -> "void*"
# cbData : DWORD -> "dword"
# grbit : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "esent" fn JetMakeKey(
sesid: usize, // JET_SESID
tableid: usize, // JET_TABLEID
pvData: ?*anyopaque, // void* optional
cbData: u32, // DWORD
grbit: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc JetMakeKey(
sesid: uint, # JET_SESID
tableid: uint, # JET_TABLEID
pvData: pointer, # void* optional
cbData: uint32, # DWORD
grbit: uint32 # DWORD
): int32 {.importc: "JetMakeKey", stdcall, dynlib: "ESENT.dll".}pragma(lib, "esent");
extern(Windows)
int JetMakeKey(
size_t sesid, // JET_SESID
size_t tableid, // JET_TABLEID
void* pvData, // void* optional
uint cbData, // DWORD
uint grbit // DWORD
);ccall((:JetMakeKey, "ESENT.dll"), stdcall, Int32,
(Csize_t, Csize_t, Ptr{Cvoid}, UInt32, UInt32),
sesid, tableid, pvData, cbData, grbit)
# sesid : JET_SESID -> Csize_t
# tableid : JET_TABLEID -> Csize_t
# pvData : void* optional -> Ptr{Cvoid}
# cbData : DWORD -> UInt32
# grbit : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t JetMakeKey(
uintptr_t sesid,
uintptr_t tableid,
void* pvData,
uint32_t cbData,
uint32_t grbit);
]]
local esent = ffi.load("esent")
-- esent.JetMakeKey(sesid, tableid, pvData, cbData, grbit)
-- sesid : JET_SESID
-- tableid : JET_TABLEID
-- pvData : void* optional
-- cbData : DWORD
-- grbit : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetMakeKey = lib.func('__stdcall', 'JetMakeKey', 'int32_t', ['uintptr_t', 'uintptr_t', 'void *', 'uint32_t', 'uint32_t']);
// JetMakeKey(sesid, tableid, pvData, cbData, grbit)
// sesid : JET_SESID -> 'uintptr_t'
// tableid : JET_TABLEID -> 'uintptr_t'
// pvData : void* optional -> 'void *'
// cbData : DWORD -> 'uint32_t'
// grbit : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ESENT.dll", {
JetMakeKey: { parameters: ["usize", "usize", "pointer", "u32", "u32"], result: "i32" },
});
// lib.symbols.JetMakeKey(sesid, tableid, pvData, cbData, grbit)
// sesid : JET_SESID -> "usize"
// tableid : JET_TABLEID -> "usize"
// pvData : void* optional -> "pointer"
// cbData : DWORD -> "u32"
// grbit : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t JetMakeKey(
size_t sesid,
size_t tableid,
void* pvData,
uint32_t cbData,
uint32_t grbit);
C, "ESENT.dll");
// $ffi->JetMakeKey(sesid, tableid, pvData, cbData, grbit);
// sesid : JET_SESID
// tableid : JET_TABLEID
// pvData : void* optional
// cbData : DWORD
// 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 JetMakeKey(
long sesid, // JET_SESID
long tableid, // JET_TABLEID
Pointer pvData, // void* optional
int cbData, // DWORD
int grbit // DWORD
);
}@[Link("esent")]
lib LibESENT
fun JetMakeKey = JetMakeKey(
sesid : LibC::SizeT, # JET_SESID
tableid : LibC::SizeT, # JET_TABLEID
pvData : Void*, # void* optional
cbData : UInt32, # DWORD
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 JetMakeKeyNative = Int32 Function(UintPtr, UintPtr, Pointer<Void>, Uint32, Uint32);
typedef JetMakeKeyDart = int Function(int, int, Pointer<Void>, int, int);
final JetMakeKey = DynamicLibrary.open('ESENT.dll')
.lookupFunction<JetMakeKeyNative, JetMakeKeyDart>('JetMakeKey');
// sesid : JET_SESID -> UintPtr
// tableid : JET_TABLEID -> UintPtr
// pvData : void* optional -> Pointer<Void>
// cbData : DWORD -> Uint32
// grbit : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function JetMakeKey(
sesid: NativeUInt; // JET_SESID
tableid: NativeUInt; // JET_TABLEID
pvData: Pointer; // void* optional
cbData: DWORD; // DWORD
grbit: DWORD // DWORD
): Integer; stdcall;
external 'ESENT.dll' name 'JetMakeKey';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "JetMakeKey"
c_JetMakeKey :: CUIntPtr -> CUIntPtr -> Ptr () -> Word32 -> Word32 -> IO Int32
-- sesid : JET_SESID -> CUIntPtr
-- tableid : JET_TABLEID -> CUIntPtr
-- pvData : void* optional -> Ptr ()
-- cbData : DWORD -> Word32
-- grbit : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let jetmakekey =
foreign "JetMakeKey"
(size_t @-> size_t @-> (ptr void) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* tableid : JET_TABLEID -> size_t *)
(* pvData : void* optional -> (ptr void) *)
(* cbData : DWORD -> 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 ("JetMakeKey" jet-make-key :convention :stdcall) :int32
(sesid :uint64) ; JET_SESID
(tableid :uint64) ; JET_TABLEID
(pv-data :pointer) ; void* optional
(cb-data :uint32) ; DWORD
(grbit :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $JetMakeKey = Win32::API::More->new('ESENT',
'int JetMakeKey(WPARAM sesid, WPARAM tableid, LPVOID pvData, DWORD cbData, DWORD grbit)');
# my $ret = $JetMakeKey->Call($sesid, $tableid, $pvData, $cbData, $grbit);
# sesid : JET_SESID -> WPARAM
# tableid : JET_TABLEID -> WPARAM
# pvData : void* optional -> LPVOID
# cbData : DWORD -> DWORD
# grbit : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。