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

JetMove

関数
カーソルを指定した行数だけ前後に移動する。
DLLESENT.dll呼出規約winapi

シグネチャ

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

INT JetMove(
    JET_SESID sesid,
    JET_TABLEID tableid,
    INT cRow,
    DWORD grbit
);

パラメーター

名前型方向説明
sesidJET_SESIDinカーソル移動を行うセッションのJET_SESIDハンドル。
tableidJET_TABLEIDin移動対象のテーブルカーソルハンドル。
cRowINTin移動する行数。正で前進、負で後退、JET_MoveFirst/JET_MoveLast等の特殊値も使える。
grbitDWORDin移動動作を制御するビットフラグ。JET_bitMoveKeyNE等でインデックスエントリ単位移動を指定する。

戻り値の型: INT

公式ドキュメント

JetMove 関数は、インデックスの先頭または末尾にカーソルを位置付け、そのインデックス内のエントリを前方または後方へたどります。また、現在のインデックス上で、指定した数のインデックスエントリ分だけカーソルを前方または後方へ移動させることもできます。別の方法として、JetSetIndexRange を使用してカーソルにインデックス範囲を設定し、JetMove で列挙できるインデックスエントリを人為的に制限することもできます。

戻り値

この関数は JET_ERR データ型を返し、その値は次の戻り値のコードのいずれかです。発生し得る ESE エラーの詳細については、「Extensible Storage Engine Errors」および「Error Handling Parameters」を参照してください。

戻り値のコード

説明

JET_errSuccess

操作は正常に完了しました。JetMove の場合、これは現在のインデックス上の要求された位置またはオフセットにインデックスエントリが見つかったことを意味します。

JET_errClientRequestToStopJetService

JetStopService の呼び出しの結果として、セッションに関連付けられたインスタンス上のすべての処理が停止したため、操作を完了できません。

JET_errInstanceUnavailable

セッションに関連付けられたインスタンスで、データの整合性を保護するためにすべてのデータへのアクセスを取り消す必要がある致命的なエラーが発生したため、操作を完了できません。

Windows XP: この戻り値は Windows XP で導入されました。

JET_errNoCurrentRecord

カーソルは現在、インデックスエントリ上に位置付けられていません。JetMove の場合、これは現在のインデックス上の要求された位置またはオフセットにインデックスエントリが見つからなかったことを意味します。

JET_errNotInitialized

セッションに関連付けられたインスタンスがまだ初期化されていないため、操作を完了できません。

JET_errRecordDeleted

カーソルは現在、削除済みのレコードに対応するインデックスエントリ上に論理的に位置付けられています。

JET_errRestoreInProgress

セッションに関連付けられたインスタンスで復元操作が進行中のため、操作を完了できません。

JET_errSessionSharingViolation

同一のセッションを、同時に複数のスレッドで使用することはできません。

Windows XP: この戻り値は Windows XP で導入されました。

JET_errTermInProgress

セッションに関連付けられたインスタンスがシャットダウン中のため、操作を完了できません。

この関数が成功すると、カーソルは要求された位置またはオフセットに一致するインデックスエントリ上に位置付けられます。更新のために準備されたレコードがある場合、その更新は取り消されます。インデックス範囲が有効で、かつ JET_MoveFirst または JET_MoveLast が指定された場合、そのインデックス範囲は解除されます。データベースの状態は変化しません。

この関数が失敗した場合、JET_errNoCurrentRecord が返されたときを除き、カーソルの位置は変化しません。JET_errNoCurrentRecord が返された場合、カーソルは、要求された位置またはオフセットに一致するインデックスエントリが存在したであろう位置に置かれます。カーソルはその位置を基準にして移動できますが、有効なインデックスエントリ上にはありません。更新のために準備されたレコードがある場合、その更新は取り消されます。インデックス範囲が有効で、かつ JET_MoveFirst または JET_MoveLast が指定された場合、そのインデックス範囲は解除されます。データベースの状態は変化しません。

解説

JetMove を使用すると、カーソルを Before First と After Last という 2 つの特別な位置に移動できます。カーソルがテーブルの最初のインデックスエントリ上にあるときに JET_MovePrevious を指定して JetMove を呼び出すと、呼び出しは JET_errNoCurrentRecord で失敗し、カーソルはインデックスの最初のエントリより前に論理的に位置付けられます。この論理的な位置は、インデックスの最初のエントリより前に別のインデックスエントリが挿入された場合でも維持されます。インデックスの末尾に関しても、After Last について同様のことが起こります。Before First と After Last は、要素を使用する前に常に次(または前)の要素へ移動することを前提とする反復子(イテレーター)モデルを用いて、JetMove で反復処理するインデックスエントリの範囲を設定する場合に特に便利です。

JetMove で参照できるインデックスエントリの集合は、カーソルにインデックス範囲を設定することで制限できます。これは、そのインデックス向けに作成した 2 つの検索キーで表現できる単純な条件に一致するインデックスエントリの集合を列挙するアプリケーションで役立ちます。詳細については、「JetSetIndexRange」を参照してください。

Windows Server 2003 SP1 より前のリリースでは、特定のケースで JetMove に問題があり、JetSetIndexRange 関数で設定したインデックス範囲が正しく適用されないことがあります。カーソルが現在、最初のインデックスエントリより前にあり、最初のインデックスエントリよりも小さい上限でインデックス範囲が設定されている場合、次の JetMove の呼び出しは、期待される JET_errNoCurrentRecord での失敗ではなく、誤ってそのインデックスエントリへ移動してしまいます。インデックスの末尾から始まる同様の状況でも、同じエラーが発生します。この状況は、インデックス範囲を設定し、列挙対象の集合に含まれる最初のインデックスエントリ上から開始するのではなく、その手前から開始することを前提とした反復子で範囲内を移動するアプリケーションで発生し得ます。インデックスの末尾から始まる同様のケースでも、この状況は発生します。回避策として、アプリケーション側で、現在のインデックスエントリのキー(JetRetrieveKey で取得)と現在のインデックス範囲の終端を表すキー(JET_bitRetrieveCopy を指定した JetRetrieveKey で取得)を比較し、取得したインデックスエントリがインデックス範囲内にあることを手動で確認します。

JetMove に計算で求めたオフセットを渡す場合は注意が必要です。計算されたオフセットが JET_MoveFirst 以下になる場合は、そのオフセットを複数に分割し、それぞれを個別に JetMove へ渡す必要がありますが、目的の結果を得るには単一のトランザクション内で行う必要があります。JET_MoveNext 以上のオフセットについても同様です。実際のアプリケーションでこのような状況に陥る可能性は低いものの、JET_MoveFirst と JET_MoveLast は通常のオフセットとはまったく異なるセマンティクスを持つため、このケースに備えておくとよいでしょう。

cRow パラメーターに 1000 を指定した場合のように、非常に大きなオフセットを指定して JetMove を呼び出すと、JetMove は最終的な位置に到達するまで 1000 個すべてのインデックスエントリをたどります。現在のところ、ESE API には、各インデックスエントリをたどらずにオフセットで指定したインデックスエントリへ直接移動する効率的な手段はありません。

要件

要件 値

クライアント

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
JetRetrieveKey
JetSetIndexRange

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)

各言語での呼び出し定義

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

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

JetMove = ctypes.windll.esent.JetMove
JetMove.restype = ctypes.c_int
JetMove.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    ctypes.c_int,  # cRow : INT
    wintypes.DWORD,  # grbit : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetMove = Fiddle::Function.new(
  lib['JetMove'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    Fiddle::TYPE_UINTPTR_T,  # tableid : JET_TABLEID
    Fiddle::TYPE_INT,  # cRow : INT
    -Fiddle::TYPE_INT,  # grbit : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "esent")]
extern "system" {
    fn JetMove(
        sesid: usize,  // JET_SESID
        tableid: usize,  // JET_TABLEID
        cRow: i32,  // INT
        grbit: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ESENT.dll")]
public static extern int JetMove(UIntPtr sesid, UIntPtr tableid, int cRow, uint grbit);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetMove' -Namespace Win32 -PassThru
# $api::JetMove(sesid, tableid, cRow, grbit)
#uselib "ESENT.dll"
#func global JetMove "JetMove" sptr, sptr, sptr, sptr
; JetMove sesid, tableid, cRow, grbit   ; 戻り値は stat
; sesid : JET_SESID -> "sptr"
; tableid : JET_TABLEID -> "sptr"
; cRow : INT -> "sptr"
; grbit : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ESENT.dll"
#cfunc global JetMove "JetMove" sptr, sptr, int, int
; res = JetMove(sesid, tableid, cRow, grbit)
; sesid : JET_SESID -> "sptr"
; tableid : JET_TABLEID -> "sptr"
; cRow : INT -> "int"
; grbit : DWORD -> "int"
; INT JetMove(JET_SESID sesid, JET_TABLEID tableid, INT cRow, DWORD grbit)
#uselib "ESENT.dll"
#cfunc global JetMove "JetMove" intptr, intptr, int, int
; res = JetMove(sesid, tableid, cRow, grbit)
; sesid : JET_SESID -> "intptr"
; tableid : JET_TABLEID -> "intptr"
; cRow : INT -> "int"
; grbit : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetMove = esent.NewProc("JetMove")
)

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

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

foreign import stdcall safe "JetMove"
  c_JetMove :: CUIntPtr -> CUIntPtr -> Int32 -> Word32 -> IO Int32
-- sesid : JET_SESID -> CUIntPtr
-- tableid : JET_TABLEID -> CUIntPtr
-- cRow : INT -> Int32
-- grbit : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetmove =
  foreign "JetMove"
    (size_t @-> size_t @-> int32_t @-> uint32_t @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* tableid : JET_TABLEID -> size_t *)
(* cRow : INT -> 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 ("JetMove" jet-move :convention :stdcall) :int32
  (sesid :uint64)   ; JET_SESID
  (tableid :uint64)   ; JET_TABLEID
  (c-row :int32)   ; INT
  (grbit :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetMove = Win32::API::More->new('ESENT',
    'int JetMove(WPARAM sesid, WPARAM tableid, int cRow, DWORD grbit)');
# my $ret = $JetMove->Call($sesid, $tableid, $cRow, $grbit);
# sesid : JET_SESID -> WPARAM
# tableid : JET_TABLEID -> WPARAM
# cRow : INT -> int
# grbit : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。