JetSetIndexRange
関数シグネチャ
// ESENT.dll
#include <windows.h>
INT JetSetIndexRange(
JET_SESID sesid,
JET_TABLEID tableidSrc,
DWORD grbit
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| sesid | JET_SESID | in | インデックス範囲設定を行うセッションのJET_SESIDハンドル。 |
| tableidSrc | JET_TABLEID | in | 範囲の終端キーを保持するソーステーブルのカーソルハンドル。 |
| grbit | DWORD | in | 範囲条件を指定するビットフラグ。JET_bitRangeUpperLimitやJET_bitRangeInclusive等で上限や境界を指定する。 |
戻り値の型: INT
公式ドキュメント
JetSetIndexRange 関数は、カーソルが JetMove を使用して移動できるインデックスエントリの集合を、現在のインデックスエントリから、そのカーソルの検索キーで指定された検索条件と指定された境界条件に一致するインデックスエントリまでに一時的に限定します。検索キーは、あらかじめ JetMakeKey を使用して構築しておく必要があります。
戻り値
この関数は JET_ERR データ型を返し、その値は次のいずれかの戻り値コードです。発生しうる ESE エラーの詳細については、Extensible Storage Engine Errors および Error Handling Parameters を参照してください。
戻り値コード |
説明 |
|---|---|
JET_errSuccess |
操作は正常に完了しました。 JetSetIndexRange の場合、これは既存のインデックス範囲が取り消されたか、またはインデックス範囲内に少なくとも 1 つのインデックスエントリが存在することを意味します。 |
JET_errClientRequestToStopJetService |
JetStopService の呼び出しの結果として、セッションに関連付けられたインスタンス上のすべての動作が停止したため、操作を完了できません。 |
JET_errInstanceUnavailable |
セッションに関連付けられたインスタンスで、データの整合性を保護するためにすべてのデータへのアクセスを取り消す必要がある致命的なエラーが発生したため、操作を完了できません。 このエラーは Windows XP 以降のリリースでのみ返されます。 |
JET_errInvalidOperation |
このエラーは、JET_bitRangeRemove が指定されたにもかかわらずインデックス範囲が有効になっていない場合に JetSetIndexRange から返されます。 |
JET_errKeyNotMade |
カーソルに現在の検索キーがありません。JetSetIndexRange はインデックスエントリを見つけるための検索条件として検索キーを使用するため、カーソルに有効な検索キーが存在することを必要とします。 |
JET_errNoCurrentIndex |
カーソルに現在のインデックスがありません。JetSetIndexRange では、カーソルがテーブルのクラスター化インデックス上にあり、プライマリインデックスが定義されていない場合にこれが発生します。そのようなインデックスに対してインデックス範囲を設定することはサポートされていません。 |
JET_errNoCurrentRecord |
このエラーは、インデックス範囲内にインデックスエントリが存在しないことを示すために JetSetIndexRange から返されます。 |
JET_errNotInitialized |
セッションに関連付けられたインスタンスがまだ初期化されていないため、操作を完了できません。 |
JET_errRestoreInProgress |
セッションに関連付けられたインスタンスで復元操作が進行中であるため、操作を完了できません。 |
JET_errSessionSharingViolation |
同じセッションを同時に複数のスレッドで使用することはできません。 このエラーは Windows XP 以降のリリースでのみ返されます。 |
JET_errTermInProgress |
セッションに関連付けられたインスタンスがシャットダウン中であるため、操作を完了できません。 |
成功した場合、JET_bitRangeRemove が指定されていると、現在有効なインデックス範囲は取り消されます。JET_bitRangeRemove が指定されておらず JET_bitRangeInstantDuration が指定されている場合は、インデックス範囲は有効になりません。JET_bitRangeRemove と JET_bitRangeInstantDuration のいずれも指定されていない場合は、新しいインデックス範囲が有効になります。このインデックス範囲は、カーソルが JetMove を使用して移動できるインデックスエントリの集合を、現在のインデックスエントリから検索条件に一致するインデックスエントリまでに一時的に限定します。カーソルの位置は変更されません。カーソルに対して検索キーが構築されていた場合、その検索キーは削除されます。データベースの状態は変更されません。
失敗した場合、JET_errNoCurrentRecord が返されていなければ、インデックス範囲は有効になりません。JET_errNoCurrentRecord が返された場合は、新しいインデックス範囲が有効になります。このインデックス範囲は、カーソルが JetMove を使用して移動できるインデックスエントリの集合を、現在のインデックスエントリから検索条件に一致するインデックスエントリまでに一時的に限定します。カーソルの位置は変更されません。JET_errNoCurrentRecord が返され、かつカーソルに対して検索キーが構築されていた場合、その検索キーは削除されます。データベースの状態は変更されません。
解説
インデックス範囲は揮発性であり、カーソルに対して JetMove 以外の移動操作が行われると自動的に取り消されます。
インデックス範囲は一方向にのみ機能します。上限が設定されている場合、インデックス範囲の終端に到達した後に抑止されるのは、JetMove を JET_MoveNext または正のオフセットとともに使用する前方への移動だけです。この場合でも、JetMove を JET_MovePrevious または負のオフセットとともに使用して、インデックス範囲の外に出ることは可能です。下限についても同様のことが当てはまります。
要件
| 要件 | 値 |
|---|---|
クライアント |
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
JetMakeKey
JetMove
JetSetIndexRange
JetStopService
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)
各言語での呼び出し定義
// ESENT.dll
#include <windows.h>
INT JetSetIndexRange(
JET_SESID sesid,
JET_TABLEID tableidSrc,
DWORD grbit
);[DllImport("ESENT.dll", ExactSpelling = true)]
static extern int JetSetIndexRange(
UIntPtr sesid, // JET_SESID
UIntPtr tableidSrc, // JET_TABLEID
uint grbit // DWORD
);<DllImport("ESENT.dll", ExactSpelling:=True)>
Public Shared Function JetSetIndexRange(
sesid As UIntPtr, ' JET_SESID
tableidSrc As UIntPtr, ' JET_TABLEID
grbit As UInteger ' DWORD
) As Integer
End Function' sesid : JET_SESID
' tableidSrc : JET_TABLEID
' grbit : DWORD
Declare PtrSafe Function JetSetIndexRange Lib "esent" ( _
ByVal sesid As LongPtr, _
ByVal tableidSrc 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
JetSetIndexRange = ctypes.windll.esent.JetSetIndexRange
JetSetIndexRange.restype = ctypes.c_int
JetSetIndexRange.argtypes = [
ctypes.c_size_t, # sesid : JET_SESID
ctypes.c_size_t, # tableidSrc : JET_TABLEID
wintypes.DWORD, # grbit : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ESENT.dll')
JetSetIndexRange = Fiddle::Function.new(
lib['JetSetIndexRange'],
[
Fiddle::TYPE_UINTPTR_T, # sesid : JET_SESID
Fiddle::TYPE_UINTPTR_T, # tableidSrc : JET_TABLEID
-Fiddle::TYPE_INT, # grbit : DWORD
],
Fiddle::TYPE_INT)#[link(name = "esent")]
extern "system" {
fn JetSetIndexRange(
sesid: usize, // JET_SESID
tableidSrc: usize, // JET_TABLEID
grbit: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("ESENT.dll")]
public static extern int JetSetIndexRange(UIntPtr sesid, UIntPtr tableidSrc, uint grbit);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetSetIndexRange' -Namespace Win32 -PassThru
# $api::JetSetIndexRange(sesid, tableidSrc, grbit)#uselib "ESENT.dll"
#func global JetSetIndexRange "JetSetIndexRange" sptr, sptr, sptr
; JetSetIndexRange sesid, tableidSrc, grbit ; 戻り値は stat
; sesid : JET_SESID -> "sptr"
; tableidSrc : JET_TABLEID -> "sptr"
; grbit : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ESENT.dll"
#cfunc global JetSetIndexRange "JetSetIndexRange" sptr, sptr, int
; res = JetSetIndexRange(sesid, tableidSrc, grbit)
; sesid : JET_SESID -> "sptr"
; tableidSrc : JET_TABLEID -> "sptr"
; grbit : DWORD -> "int"; INT JetSetIndexRange(JET_SESID sesid, JET_TABLEID tableidSrc, DWORD grbit)
#uselib "ESENT.dll"
#cfunc global JetSetIndexRange "JetSetIndexRange" intptr, intptr, int
; res = JetSetIndexRange(sesid, tableidSrc, grbit)
; sesid : JET_SESID -> "intptr"
; tableidSrc : JET_TABLEID -> "intptr"
; grbit : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
esent = windows.NewLazySystemDLL("ESENT.dll")
procJetSetIndexRange = esent.NewProc("JetSetIndexRange")
)
// sesid (JET_SESID), tableidSrc (JET_TABLEID), grbit (DWORD)
r1, _, err := procJetSetIndexRange.Call(
uintptr(sesid),
uintptr(tableidSrc),
uintptr(grbit),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction JetSetIndexRange(
sesid: NativeUInt; // JET_SESID
tableidSrc: NativeUInt; // JET_TABLEID
grbit: DWORD // DWORD
): Integer; stdcall;
external 'ESENT.dll' name 'JetSetIndexRange';result := DllCall("ESENT\JetSetIndexRange"
, "UPtr", sesid ; JET_SESID
, "UPtr", tableidSrc ; JET_TABLEID
, "UInt", grbit ; DWORD
, "Int") ; return: INT●JetSetIndexRange(sesid, tableidSrc, grbit) = DLL("ESENT.dll", "int JetSetIndexRange(int, int, dword)")
# 呼び出し: JetSetIndexRange(sesid, tableidSrc, grbit)
# sesid : JET_SESID -> "int"
# tableidSrc : JET_TABLEID -> "int"
# grbit : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "esent" fn JetSetIndexRange(
sesid: usize, // JET_SESID
tableidSrc: usize, // JET_TABLEID
grbit: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc JetSetIndexRange(
sesid: uint, # JET_SESID
tableidSrc: uint, # JET_TABLEID
grbit: uint32 # DWORD
): int32 {.importc: "JetSetIndexRange", stdcall, dynlib: "ESENT.dll".}pragma(lib, "esent");
extern(Windows)
int JetSetIndexRange(
size_t sesid, // JET_SESID
size_t tableidSrc, // JET_TABLEID
uint grbit // DWORD
);ccall((:JetSetIndexRange, "ESENT.dll"), stdcall, Int32,
(Csize_t, Csize_t, UInt32),
sesid, tableidSrc, grbit)
# sesid : JET_SESID -> Csize_t
# tableidSrc : JET_TABLEID -> Csize_t
# grbit : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t JetSetIndexRange(
uintptr_t sesid,
uintptr_t tableidSrc,
uint32_t grbit);
]]
local esent = ffi.load("esent")
-- esent.JetSetIndexRange(sesid, tableidSrc, grbit)
-- sesid : JET_SESID
-- tableidSrc : JET_TABLEID
-- grbit : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetSetIndexRange = lib.func('__stdcall', 'JetSetIndexRange', 'int32_t', ['uintptr_t', 'uintptr_t', 'uint32_t']);
// JetSetIndexRange(sesid, tableidSrc, grbit)
// sesid : JET_SESID -> 'uintptr_t'
// tableidSrc : JET_TABLEID -> 'uintptr_t'
// grbit : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ESENT.dll", {
JetSetIndexRange: { parameters: ["usize", "usize", "u32"], result: "i32" },
});
// lib.symbols.JetSetIndexRange(sesid, tableidSrc, grbit)
// sesid : JET_SESID -> "usize"
// tableidSrc : JET_TABLEID -> "usize"
// grbit : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t JetSetIndexRange(
size_t sesid,
size_t tableidSrc,
uint32_t grbit);
C, "ESENT.dll");
// $ffi->JetSetIndexRange(sesid, tableidSrc, grbit);
// sesid : JET_SESID
// tableidSrc : JET_TABLEID
// 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 JetSetIndexRange(
long sesid, // JET_SESID
long tableidSrc, // JET_TABLEID
int grbit // DWORD
);
}@[Link("esent")]
lib LibESENT
fun JetSetIndexRange = JetSetIndexRange(
sesid : LibC::SizeT, # JET_SESID
tableidSrc : LibC::SizeT, # JET_TABLEID
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 JetSetIndexRangeNative = Int32 Function(UintPtr, UintPtr, Uint32);
typedef JetSetIndexRangeDart = int Function(int, int, int);
final JetSetIndexRange = DynamicLibrary.open('ESENT.dll')
.lookupFunction<JetSetIndexRangeNative, JetSetIndexRangeDart>('JetSetIndexRange');
// sesid : JET_SESID -> UintPtr
// tableidSrc : JET_TABLEID -> UintPtr
// grbit : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function JetSetIndexRange(
sesid: NativeUInt; // JET_SESID
tableidSrc: NativeUInt; // JET_TABLEID
grbit: DWORD // DWORD
): Integer; stdcall;
external 'ESENT.dll' name 'JetSetIndexRange';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "JetSetIndexRange"
c_JetSetIndexRange :: CUIntPtr -> CUIntPtr -> Word32 -> IO Int32
-- sesid : JET_SESID -> CUIntPtr
-- tableidSrc : JET_TABLEID -> CUIntPtr
-- grbit : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let jetsetindexrange =
foreign "JetSetIndexRange"
(size_t @-> size_t @-> uint32_t @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* tableidSrc : JET_TABLEID -> 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 ("JetSetIndexRange" jet-set-index-range :convention :stdcall) :int32
(sesid :uint64) ; JET_SESID
(tableid-src :uint64) ; JET_TABLEID
(grbit :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $JetSetIndexRange = Win32::API::More->new('ESENT',
'int JetSetIndexRange(WPARAM sesid, WPARAM tableidSrc, DWORD grbit)');
# my $ret = $JetSetIndexRange->Call($sesid, $tableidSrc, $grbit);
# sesid : JET_SESID -> WPARAM
# tableidSrc : JET_TABLEID -> WPARAM
# grbit : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。