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

JetSetCurrentIndexW

関数
カーソルで使用する現在のインデックスを設定する(Unicode版)。
DLLESENT.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

// ESENT.dll  (Unicode / -W)
#include <windows.h>

INT JetSetCurrentIndexW(
    JET_SESID sesid,
    JET_TABLEID tableid,
    WORD* szIndexName   // optional
);

パラメーター

名前型方向説明
sesidJET_SESIDin現在インデックス設定を行うセッションのJET_SESIDハンドル。
tableidJET_TABLEIDin対象テーブルのカーソルハンドル。
szIndexNameWORD*inoptional有効化するインデックス名を指す終端付きUnicode文字列ポインタ。NULLで主インデックスに戻す。

戻り値の型: INT

公式ドキュメント

JetSetCurrentIndex 関数は、カーソルの現在のインデックスを設定するために使用します。カーソルの現在のインデックスは、レコードを公開するために使用するインデックスエントリのセットを選択することによって、そのカーソルからテーブル内のどのレコードが参照できるか、およびそれらがどのような順序で現れるかを定義します。

戻り値

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

戻りコード

説明

JET_errSuccess

操作は正常に完了しました。

JET_errBadItagSequence

JET_bitNoMove オプションを指定してセカンダリインデックスを選択しようとしましたが、新しいインデックスの定義における最初の複数値キー列に、指定されたシーケンス番号に対応する値がありません。

JET_errClientRequestToStopJetService

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

JET_errInvalidIndexId

インデックス ID の内容が無効であるか、有効期限が切れているため再取得が必要です。JetSetCurrentIndex では次の場合に発生することがあります。

  • pindexid->cbStruct が想定されるサイズではない (Windows Server 2003 以降のリリース)。

  • インデックス ID を取得した後にエンジンがシャットダウンされた。

  • インデックス ID に対応するインデックスを含むテーブルを参照していたカーソルがすべて閉じられ、エンジンがそのインデックスの定義をスキーマキャッシュから破棄した。

  • 誤ったテーブルで開かれたカーソルに対してインデックス ID が使用されている。

  • インデックスが削除されているか、まだそのセッションから参照できない。

JET_errInstanceUnavailable

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

このエラーは Windows XP 以降のリリースでのみ返されます。

JET_errInvalidName

指定されたオブジェクト名のいずれかが無効です。すべてのオブジェクト名は同一の規則に従う必要があります。規則は次のとおりです。

  • オブジェクト名は ASCII 文字で構成されている必要があります。

  • オブジェクト名は 1 文字以上である必要があります。

  • オブジェクト名の長さは JET_cbNameMost (64) 文字を超えることはできません。

  • オブジェクト名の先頭をスペースにすることはできません。

  • オブジェクト名に ASCII 制御文字 (0x00 から 0x1F) を含めることはできません。

  • オブジェクト名に感嘆符 (!)、ピリオド (.)、左角かっこ ([)、右角かっこ (]) を含めることはできません。

  • 検証後、文字列のうち最初のスペース (存在する場合) までの部分のみがオブジェクト名として使用されます。これは事実上、オブジェクト名にスペースを含めることもできないことを意味します。

JET_errInvalidParameter

指定されたパラメーターのいずれかに予期しない値が含まれていたか、別のパラメーターの値と組み合わせたときに意味を成さない値が含まれていました。JetSetCurrentIndex では、pindexid が NULL ではなく、かつ pindexid->cbStruct が想定されるサイズではない場合に発生することがあります (Windows XP 以前のリリース)。

JET_errNoCurrentRecord

JET_bitNoMove オプションを指定してセカンダリインデックスを選択しようとしましたが、古いインデックス上のカーソルの現在位置にあるインデックスエントリに関連付けられたレコードに対応するインデックスエントリが、新しいインデックスに存在しません。

JET_errNotInitialized

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

JET_errOutOfCursors

エンジンが、カーソルを開くために使用するリソースのプールを使い果たしました。同時に開くことができるカーソルの最大数は JET_paramMaxCursors によって制御されます。詳細については JetSetSystemParameter を参照してください。JetSetCurrentIndex では、セカンダリインデックスが選択され、エンジンがそのインデックスを使用するための内部カーソルを開けない場合に発生することがあります。

JET_errRestoreInProgress

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

JET_errSessionSharingViolation

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

このエラーは Windows XP 以降のリリースでのみ返されます。

JET_errTermInProgress

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

成功した場合、カーソルの現在のインデックスは要求されたインデックスに設定されます。以降、要求されたインデックスのインデックス定義に従って JetSeek でインデックスエントリを検索できます。また、そのインデックス定義で指定された順序で JetMove を使用してインデックスエントリを列挙することもできます。カーソルの現在位置は、そのインデックスの最初のインデックスエントリ (JET_bitMoveFirst) か、古いインデックス上のカーソルの現在位置に関連する特定のインデックスエントリ (JET_bitNoMove) のいずれかに設定されます。データベースの状態は変更されません。

失敗した場合、カーソルの現在のインデックスおよび現在位置は未定義の状態になります。データベースの状態は変更されません。

解説

インデックス ID のヒントが古くなっている場合、この API は単に失敗します。この場合、想定されるようなインデックスのテキスト名へのフォールバックは行われません。このフォールバックは、API の呼び出し元が手動で行う必要があります。

要件

要件 値

クライアント

Windows Vista、Windows XP、または Windows 2000 Professional が必要です。

サーバー

Windows Server 2008、Windows Server 2003、または Windows 2000 Server が必要です。

ヘッダー

Esent.h で宣言されています。

ライブラリ

ESENT.lib を使用します。

DLL

ESENT.dll が必要です。

Unicode

JetSetCurrentIndexW (Unicode) および JetSetCurrentIndexA (ANSI) として実装されています。

関連項目

JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JET_INDEXID
JetCreateIndex
JetGetCurrentIndex
JetGetIndexInfo
JetGetTableIndexInfo
JetMove
JetSeek
JetSetCurrentIndex
JetSetSystemParameter
JetStopService

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

各言語での呼び出し定義

// ESENT.dll  (Unicode / -W)
#include <windows.h>

INT JetSetCurrentIndexW(
    JET_SESID sesid,
    JET_TABLEID tableid,
    WORD* szIndexName   // optional
);
[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetSetCurrentIndexW(
    UIntPtr sesid,   // JET_SESID
    UIntPtr tableid,   // JET_TABLEID
    IntPtr szIndexName   // WORD* optional
);
<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetSetCurrentIndexW(
    sesid As UIntPtr,   ' JET_SESID
    tableid As UIntPtr,   ' JET_TABLEID
    szIndexName As IntPtr   ' WORD* optional
) As Integer
End Function
' sesid : JET_SESID
' tableid : JET_TABLEID
' szIndexName : WORD* optional
Declare PtrSafe Function JetSetCurrentIndexW Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal tableid As LongPtr, _
    ByVal szIndexName As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

JetSetCurrentIndexW = ctypes.windll.esent.JetSetCurrentIndexW
JetSetCurrentIndexW.restype = ctypes.c_int
JetSetCurrentIndexW.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    ctypes.POINTER(ctypes.c_ushort),  # szIndexName : WORD* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetSetCurrentIndexW = esent.NewProc("JetSetCurrentIndexW")
)

// sesid (JET_SESID), tableid (JET_TABLEID), szIndexName (WORD* optional)
r1, _, err := procJetSetCurrentIndexW.Call(
	uintptr(sesid),
	uintptr(tableid),
	uintptr(szIndexName),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function JetSetCurrentIndexW(
  sesid: NativeUInt;   // JET_SESID
  tableid: NativeUInt;   // JET_TABLEID
  szIndexName: Pointer   // WORD* optional
): Integer; stdcall;
  external 'ESENT.dll' name 'JetSetCurrentIndexW';
result := DllCall("ESENT\JetSetCurrentIndexW"
    , "UPtr", sesid   ; JET_SESID
    , "UPtr", tableid   ; JET_TABLEID
    , "Ptr", szIndexName   ; WORD* optional
    , "Int")   ; return: INT
●JetSetCurrentIndexW(sesid, tableid, szIndexName) = DLL("ESENT.dll", "int JetSetCurrentIndexW(int, int, void*)")
# 呼び出し: JetSetCurrentIndexW(sesid, tableid, szIndexName)
# sesid : JET_SESID -> "int"
# tableid : JET_TABLEID -> "int"
# szIndexName : WORD* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "esent" fn JetSetCurrentIndexW(
    sesid: usize, // JET_SESID
    tableid: usize, // JET_TABLEID
    szIndexName: [*c]u16 // WORD* optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc JetSetCurrentIndexW(
    sesid: uint,  # JET_SESID
    tableid: uint,  # JET_TABLEID
    szIndexName: ptr uint16  # WORD* optional
): int32 {.importc: "JetSetCurrentIndexW", stdcall, dynlib: "ESENT.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "esent");
extern(Windows)
int JetSetCurrentIndexW(
    size_t sesid,   // JET_SESID
    size_t tableid,   // JET_TABLEID
    ushort* szIndexName   // WORD* optional
);
ccall((:JetSetCurrentIndexW, "ESENT.dll"), stdcall, Int32,
      (Csize_t, Csize_t, Ptr{UInt16}),
      sesid, tableid, szIndexName)
# sesid : JET_SESID -> Csize_t
# tableid : JET_TABLEID -> Csize_t
# szIndexName : WORD* optional -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetSetCurrentIndexW(
    uintptr_t sesid,
    uintptr_t tableid,
    uint16_t* szIndexName);
]]
local esent = ffi.load("esent")
-- esent.JetSetCurrentIndexW(sesid, tableid, szIndexName)
-- sesid : JET_SESID
-- tableid : JET_TABLEID
-- szIndexName : WORD* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetSetCurrentIndexW = lib.func('__stdcall', 'JetSetCurrentIndexW', 'int32_t', ['uintptr_t', 'uintptr_t', 'uint16_t *']);
// JetSetCurrentIndexW(sesid, tableid, szIndexName)
// sesid : JET_SESID -> 'uintptr_t'
// tableid : JET_TABLEID -> 'uintptr_t'
// szIndexName : WORD* optional -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetSetCurrentIndexW: { parameters: ["usize", "usize", "pointer"], result: "i32" },
});
// lib.symbols.JetSetCurrentIndexW(sesid, tableid, szIndexName)
// sesid : JET_SESID -> "usize"
// tableid : JET_TABLEID -> "usize"
// szIndexName : WORD* optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetSetCurrentIndexW(
    size_t sesid,
    size_t tableid,
    uint16_t* szIndexName);
C, "ESENT.dll");
// $ffi->JetSetCurrentIndexW(sesid, tableid, szIndexName);
// sesid : JET_SESID
// tableid : JET_TABLEID
// szIndexName : WORD* optional
// 構造体/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, W32APIOptions.UNICODE_OPTIONS);
    int JetSetCurrentIndexW(
        long sesid,   // JET_SESID
        long tableid,   // JET_TABLEID
        ShortByReference szIndexName   // WORD* optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("esent")]
lib LibESENT
  fun JetSetCurrentIndexW = JetSetCurrentIndexW(
    sesid : LibC::SizeT,   # JET_SESID
    tableid : LibC::SizeT,   # JET_TABLEID
    szIndexName : UInt16*   # WORD* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef JetSetCurrentIndexWNative = Int32 Function(UintPtr, UintPtr, Pointer<Uint16>);
typedef JetSetCurrentIndexWDart = int Function(int, int, Pointer<Uint16>);
final JetSetCurrentIndexW = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetSetCurrentIndexWNative, JetSetCurrentIndexWDart>('JetSetCurrentIndexW');
// sesid : JET_SESID -> UintPtr
// tableid : JET_TABLEID -> UintPtr
// szIndexName : WORD* optional -> Pointer<Uint16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetSetCurrentIndexW(
  sesid: NativeUInt;   // JET_SESID
  tableid: NativeUInt;   // JET_TABLEID
  szIndexName: Pointer   // WORD* optional
): Integer; stdcall;
  external 'ESENT.dll' name 'JetSetCurrentIndexW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetSetCurrentIndexW"
  c_JetSetCurrentIndexW :: CUIntPtr -> CUIntPtr -> Ptr Word16 -> IO Int32
-- sesid : JET_SESID -> CUIntPtr
-- tableid : JET_TABLEID -> CUIntPtr
-- szIndexName : WORD* optional -> Ptr Word16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetsetcurrentindexw =
  foreign "JetSetCurrentIndexW"
    (size_t @-> size_t @-> (ptr uint16_t) @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* tableid : JET_TABLEID -> size_t *)
(* szIndexName : WORD* optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library esent (t "ESENT.dll"))
(cffi:use-foreign-library esent)

(cffi:defcfun ("JetSetCurrentIndexW" jet-set-current-index-w :convention :stdcall) :int32
  (sesid :uint64)   ; JET_SESID
  (tableid :uint64)   ; JET_TABLEID
  (sz-index-name :pointer))   ; WORD* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetSetCurrentIndexW = Win32::API::More->new('ESENT',
    'int JetSetCurrentIndexW(WPARAM sesid, WPARAM tableid, LPVOID szIndexName)');
# my $ret = $JetSetCurrentIndexW->Call($sesid, $tableid, $szIndexName);
# sesid : JET_SESID -> WPARAM
# tableid : JET_TABLEID -> WPARAM
# szIndexName : WORD* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API