JetGetIndexInfoW

関数

テーブル名とインデックス名からインデックス情報を取得する(Unicode版)。

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

シグネチャ

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

INT JetGetIndexInfoW(
    JET_SESID sesid,
    DWORD dbid,
    WORD* szTableName,
    WORD* szIndexName,   // optional
    void* pvResult,
    DWORD cbResult,
    DWORD InfoLevel
);

パラメーター

名前	型	方向	説明
sesid	JET_SESID	in	操作に使用するセッションID。
dbid	DWORD	in	対象テーブルを含むデータベースのID。
szTableName	WORD*	in	対象テーブル名を指すワイド文字列(WORD*)。
szIndexName	WORD*	inoptional	情報を取得するインデックス名を指すワイド文字列(WORD*)。NULL可。
pvResult	void*	out	取得したインデックス情報を受け取る出力バッファへのポインタ。
cbResult	DWORD	in	pvResultバッファのバイトサイズ。
InfoLevel	DWORD	in	取得する情報レベル(JET_IdxInfo系定数)。

戻り値の型: INT

公式ドキュメント

JetGetIndexInfo 関数は、インデックスに関する情報を取得します。

戻り値

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

戻りコード	説明
JET_errSuccess	操作は正常に完了しました。
JET_errIndexNotFound	指定されたインデックスが、指定されたテーブル内に見つかりません。
JET_wrnBufferTruncated	pvResult として渡されたバッファーが小さすぎました。バッファーの内容は未定義です。

解説

JetGetIndexInfo と JetGetTableIndexInfo は、インデックスについて同一の情報を取得します。違いはテーブルの指定方法です。JetGetIndexInfo はデータベース (dbid) とテーブル名 (szTableName) を必要とし、JetGetTableIndexInfo はテーブル識別子 (tableid) を必要とします。

インデックスが消費する領域は $Used + Avail = Owned$ で定義されます。そのため、使用中のページ数を取得するには、 $Owned - Avail = Used$ の式を使用します (JET_IdxInfoSpaceOwned と JET_IdxInfoSpaceAvail で取得できます)。

要件

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

各言語での呼び出し定義

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

INT JetGetIndexInfoW(
    JET_SESID sesid,
    DWORD dbid,
    WORD* szTableName,
    WORD* szIndexName,   // optional
    void* pvResult,
    DWORD cbResult,
    DWORD InfoLevel
);

[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetGetIndexInfoW(
    UIntPtr sesid,   // JET_SESID
    uint dbid,   // DWORD
    ref ushort szTableName,   // WORD*
    IntPtr szIndexName,   // WORD* optional
    IntPtr pvResult,   // void* out
    uint cbResult,   // DWORD
    uint InfoLevel   // DWORD
);

<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetGetIndexInfoW(
    sesid As UIntPtr,   ' JET_SESID
    dbid As UInteger,   ' DWORD
    ByRef szTableName As UShort,   ' WORD*
    szIndexName As IntPtr,   ' WORD* optional
    pvResult As IntPtr,   ' void* out
    cbResult As UInteger,   ' DWORD
    InfoLevel As UInteger   ' DWORD
) As Integer
End Function

' sesid : JET_SESID
' dbid : DWORD
' szTableName : WORD*
' szIndexName : WORD* optional
' pvResult : void* out
' cbResult : DWORD
' InfoLevel : DWORD
Declare PtrSafe Function JetGetIndexInfoW Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal dbid As Long, _
    ByRef szTableName As Integer, _
    ByVal szIndexName As LongPtr, _
    ByVal pvResult As LongPtr, _
    ByVal cbResult As Long, _
    ByVal InfoLevel As Long) 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

JetGetIndexInfoW = ctypes.windll.esent.JetGetIndexInfoW
JetGetIndexInfoW.restype = ctypes.c_int
JetGetIndexInfoW.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    wintypes.DWORD,  # dbid : DWORD
    ctypes.POINTER(ctypes.c_ushort),  # szTableName : WORD*
    ctypes.POINTER(ctypes.c_ushort),  # szIndexName : WORD* optional
    ctypes.POINTER(None),  # pvResult : void* out
    wintypes.DWORD,  # cbResult : DWORD
    wintypes.DWORD,  # InfoLevel : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetGetIndexInfoW = Fiddle::Function.new(
  lib['JetGetIndexInfoW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    -Fiddle::TYPE_INT,  # dbid : DWORD
    Fiddle::TYPE_VOIDP,  # szTableName : WORD*
    Fiddle::TYPE_VOIDP,  # szIndexName : WORD* optional
    Fiddle::TYPE_VOIDP,  # pvResult : void* out
    -Fiddle::TYPE_INT,  # cbResult : DWORD
    -Fiddle::TYPE_INT,  # InfoLevel : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "esent")]
extern "system" {
    fn JetGetIndexInfoW(
        sesid: usize,  // JET_SESID
        dbid: u32,  // DWORD
        szTableName: *mut u16,  // WORD*
        szIndexName: *mut u16,  // WORD* optional
        pvResult: *mut (),  // void* out
        cbResult: u32,  // DWORD
        InfoLevel: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Unicode)]
public static extern int JetGetIndexInfoW(UIntPtr sesid, uint dbid, ref ushort szTableName, IntPtr szIndexName, IntPtr pvResult, uint cbResult, uint InfoLevel);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetGetIndexInfoW' -Namespace Win32 -PassThru
# $api::JetGetIndexInfoW(sesid, dbid, szTableName, szIndexName, pvResult, cbResult, InfoLevel)

#uselib "ESENT.dll"
#func global JetGetIndexInfoW "JetGetIndexInfoW" wptr, wptr, wptr, wptr, wptr, wptr, wptr
; JetGetIndexInfoW sesid, dbid, varptr(szTableName), varptr(szIndexName), pvResult, cbResult, InfoLevel   ; 戻り値は stat
; sesid : JET_SESID -> "wptr"
; dbid : DWORD -> "wptr"
; szTableName : WORD* -> "wptr"
; szIndexName : WORD* optional -> "wptr"
; pvResult : void* out -> "wptr"
; cbResult : DWORD -> "wptr"
; InfoLevel : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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