JetGetCurrentIndexA

関数

カーソルの現在のインデックス名を取得する(ANSI版)。

DLLESENT.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

// ESENT.dll  (ANSI / -A)
#include <windows.h>

INT JetGetCurrentIndexA(
    JET_SESID sesid,
    JET_TABLEID tableid,
    CHAR* szIndexName,
    DWORD cbIndexName
);

パラメーター

名前	型	方向	説明
sesid	JET_SESID	in	現在インデックス取得を行うセッションのJET_SESIDハンドル。
tableid	JET_TABLEID	in	対象テーブルのカーソルハンドル。
szIndexName	CHAR*	out	現在の有効インデックス名を受け取る出力ANSI文字列バッファポインタ。
cbIndexName	DWORD	in	szIndexNameバッファのサイズをバイト単位で指定する値。

戻り値の型: INT

公式ドキュメント

JetGetCurrentIndex 関数は、指定したカーソルの現在のインデックスの名前を取得します。この名前は、後で JetSetCurrentIndex を使用してそのインデックスを現在のインデックスとして再選択する際にも使用されます。また、JetGetTableIndexInfo を使用してそのインデックスのプロパティを調べる際にも使用できます。

戻り値

この関数は JET_ERR データ型を返し、次のいずれかのリターンコードを含みます。ESE エラーの詳細については、Extensible Storage Engine Errors および Error Handling Parameters を参照してください。

リターンコード	説明
JET_errSuccess	操作は正常に完了しました。
JET_errClientRequestToStopJetService	JetStopService の呼び出しによって、セッションに関連付けられたインスタンス上のすべての動作が停止しているため、操作を完了できません。
JET_errInstanceUnavailable	セッションに関連付けられたインスタンスで、データの整合性を保護するためにすべてのデータへのアクセスを取り消す必要がある致命的なエラーが発生したため、操作を完了できません。このエラーは Windows XP 以降のリリースでのみ返されます。
JET_errNotInitialized	セッションに関連付けられたインスタンスがまだ初期化されていないため、操作を完了できません。
JET_errRestoreInProgress	セッションに関連付けられたインスタンスで復元操作が進行中であるため、操作を完了できません。
JET_errSessionSharingViolation	同じセッションを複数のスレッドで同時に使用することはできません。このエラーは Windows XP 以降のリリースでのみ返されます。
JET_errTermInProgress	セッションに関連付けられたインスタンスがシャットダウン中であるため、操作を完了できません。
JET_wrnBufferTruncated	操作は正常に完了しましたが、出力バッファーが小さすぎてインデックス名全体を受け取ることができませんでした。出力バッファーには、収まる範囲でインデックス名が格納されます。出力バッファーの長さが 1 文字以上であれば、その出力バッファー内の文字列は null で終端されます。注意 cchIndexName が 0 の場合、このエラーは返されません。詳細については「解説」セクションを参照してください。

成功した場合、指定したカーソルの現在のインデックスの名前が出力バッファーに返されます。JET_wrnBufferTruncated が返された場合、出力バッファーには、指定された領域に収まる範囲でインデックス名が格納されます。出力バッファーの長さが 1 文字以上であれば、そのバッファーに返される文字列は null で終端されます。データベースの状態は変更されません。

失敗した場合、出力バッファーの状態は未定義です。データベースの状態は変更されません。

解説

カーソルに現在のインデックスが存在しない場合は、空の文字列が返されます。これは、カーソルがテーブルのクラスター化インデックス上にあり、主インデックスが定義されていない場合に発生することがあります。このインデックスはテーブルのシーケンシャルインデックスと呼ばれ、定義を持ちません。いずれの場合も、JetSetCurrentIndex を使用して現在のインデックスに空の文字列を設定すると、主インデックスの定義の有無にかかわらずクラスター化インデックスが選択されます。

この関数には、すべてのリリースに存在する重要なバグがあります。出力バッファーが小さすぎてインデックス名全体を受け取れない場合でも、出力バッファーの長さが 1 文字以上であれば JET_wrnBufferTruncated は返されません。代わりに JET_errSuccess が返されます。この問題を回避するため、出力バッファーの長さは常に JET_cbNameMost + 1 (65) 文字以上にしてください。

要件

要件	値
クライアント	Windows Vista、Windows XP、または Windows 2000 Professional が必要です。
サーバー	Windows Server 2008、Windows Server 2003、または Windows 2000 Server が必要です。
ヘッダー	Esent.h で宣言されています。
ライブラリ	ESENT.lib を使用します。
DLL	ESENT.dll が必要です。
Unicode	JetGetCurrentIndexW (Unicode) および JetGetCurrentIndexA (ANSI) として実装されています。

各言語での呼び出し定義

// ESENT.dll  (ANSI / -A)
#include <windows.h>

INT JetGetCurrentIndexA(
    JET_SESID sesid,
    JET_TABLEID tableid,
    CHAR* szIndexName,
    DWORD cbIndexName
);

[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetGetCurrentIndexA(
    UIntPtr sesid,   // JET_SESID
    UIntPtr tableid,   // JET_TABLEID
    IntPtr szIndexName,   // CHAR* out
    uint cbIndexName   // DWORD
);

<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetGetCurrentIndexA(
    sesid As UIntPtr,   ' JET_SESID
    tableid As UIntPtr,   ' JET_TABLEID
    szIndexName As IntPtr,   ' CHAR* out
    cbIndexName As UInteger   ' DWORD
) As Integer
End Function

' sesid : JET_SESID
' tableid : JET_TABLEID
' szIndexName : CHAR* out
' cbIndexName : DWORD
Declare PtrSafe Function JetGetCurrentIndexA Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal tableid As LongPtr, _
    ByVal szIndexName As LongPtr, _
    ByVal cbIndexName As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

JetGetCurrentIndexA = ctypes.windll.esent.JetGetCurrentIndexA
JetGetCurrentIndexA.restype = ctypes.c_int
JetGetCurrentIndexA.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    ctypes.POINTER(ctypes.c_byte),  # szIndexName : CHAR* out
    wintypes.DWORD,  # cbIndexName : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetGetCurrentIndexA = Fiddle::Function.new(
  lib['JetGetCurrentIndexA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    Fiddle::TYPE_UINTPTR_T,  # tableid : JET_TABLEID
    Fiddle::TYPE_VOIDP,  # szIndexName : CHAR* out
    -Fiddle::TYPE_INT,  # cbIndexName : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "esent")]
extern "system" {
    fn JetGetCurrentIndexA(
        sesid: usize,  // JET_SESID
        tableid: usize,  // JET_TABLEID
        szIndexName: *mut i8,  // CHAR* out
        cbIndexName: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Ansi)]
public static extern int JetGetCurrentIndexA(UIntPtr sesid, UIntPtr tableid, IntPtr szIndexName, uint cbIndexName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetGetCurrentIndexA' -Namespace Win32 -PassThru
# $api::JetGetCurrentIndexA(sesid, tableid, szIndexName, cbIndexName)

#uselib "ESENT.dll"
#func global JetGetCurrentIndexA "JetGetCurrentIndexA" sptr, sptr, sptr, sptr
; JetGetCurrentIndexA sesid, tableid, varptr(szIndexName), cbIndexName   ; 戻り値は stat
; sesid : JET_SESID -> "sptr"
; tableid : JET_TABLEID -> "sptr"
; szIndexName : CHAR* out -> "sptr"
; cbIndexName : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ESENT.dll"
#cfunc global JetGetCurrentIndexA "JetGetCurrentIndexA" sptr, sptr, var, int
; res = JetGetCurrentIndexA(sesid, tableid, szIndexName, cbIndexName)
; sesid : JET_SESID -> "sptr"
; tableid : JET_TABLEID -> "sptr"
; szIndexName : CHAR* out -> "var"
; cbIndexName : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ESENT.dll"
#cfunc global JetGetCurrentIndexA "JetGetCurrentIndexA" sptr, sptr, sptr, int
; res = JetGetCurrentIndexA(sesid, tableid, varptr(szIndexName), cbIndexName)
; sesid : JET_SESID -> "sptr"
; tableid : JET_TABLEID -> "sptr"
; szIndexName : CHAR* out -> "sptr"
; cbIndexName : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。