JetGetIndexInfoA

関数

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

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

シグネチャ

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

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

パラメーター

名前	型	方向	説明
sesid	JET_SESID	in	操作に使用するセッションID。
dbid	DWORD	in	対象テーブルを含むデータベースのID。
szTableName	CHAR*	in	対象テーブル名を指すANSI文字列。
szIndexName	CHAR*	inoptional	情報を取得するインデックス名を指すANSI文字列。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  (ANSI / -A)
#include <windows.h>

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

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

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

' sesid : JET_SESID
' dbid : DWORD
' szTableName : CHAR*
' szIndexName : CHAR* optional
' pvResult : void* out
' cbResult : DWORD
' InfoLevel : DWORD
Declare PtrSafe Function JetGetIndexInfoA Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal dbid As Long, _
    ByVal szTableName As LongPtr, _
    ByVal szIndexName As LongPtr, _
    ByVal pvResult As LongPtr, _
    ByVal cbResult As Long, _
    ByVal InfoLevel As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

JetGetIndexInfoA = ctypes.windll.esent.JetGetIndexInfoA
JetGetIndexInfoA.restype = ctypes.c_int
JetGetIndexInfoA.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    wintypes.DWORD,  # dbid : DWORD
    ctypes.POINTER(ctypes.c_byte),  # szTableName : CHAR*
    ctypes.POINTER(ctypes.c_byte),  # szIndexName : CHAR* 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')
JetGetIndexInfoA = Fiddle::Function.new(
  lib['JetGetIndexInfoA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    -Fiddle::TYPE_INT,  # dbid : DWORD
    Fiddle::TYPE_VOIDP,  # szTableName : CHAR*
    Fiddle::TYPE_VOIDP,  # szIndexName : CHAR* optional
    Fiddle::TYPE_VOIDP,  # pvResult : void* out
    -Fiddle::TYPE_INT,  # cbResult : DWORD
    -Fiddle::TYPE_INT,  # InfoLevel : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "esent")]
extern "system" {
    fn JetGetIndexInfoA(
        sesid: usize,  // JET_SESID
        dbid: u32,  // DWORD
        szTableName: *mut i8,  // CHAR*
        szIndexName: *mut i8,  // CHAR* 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.Ansi)]
public static extern int JetGetIndexInfoA(UIntPtr sesid, uint dbid, IntPtr szTableName, IntPtr szIndexName, IntPtr pvResult, uint cbResult, uint InfoLevel);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetGetIndexInfoA' -Namespace Win32 -PassThru
# $api::JetGetIndexInfoA(sesid, dbid, szTableName, szIndexName, pvResult, cbResult, InfoLevel)

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

出力引数:

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