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

JetGetTableIndexInfoW

関数
テーブルIDで指定したテーブルのインデックス情報を取得する(Unicode版)。
DLLESENT.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

INT JetGetTableIndexInfoW(
    JET_SESID sesid,
    JET_TABLEID tableid,
    WORD* szIndexName,   // optional
    void* pvResult,
    DWORD cbResult,
    DWORD InfoLevel
);

パラメーター

名前型方向説明
sesidJET_SESIDin操作に使用するセッションID。
tableidJET_TABLEIDin対象テーブルのカーソルID。
szIndexNameWORD*inoptional情報を取得するインデックス名を指すワイド文字列(WORD*)。NULLで現在のインデックスが対象。
pvResultvoid*out取得したインデックス情報を受け取る出力バッファへのポインタ。
cbResultDWORDinpvResultバッファのバイトサイズ。
InfoLevelDWORDin取得する情報レベル(JET_IdxInfo系定数)。

戻り値の型: INT

公式ドキュメント

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

戻り値

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

リターンコード

説明

JET_errSuccess

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

JET_errIndexNotFound

指定されたインデックスが、指定されたテーブル内に見つかりません。

JET_wrnBufferTruncated

pvResult として渡されたバッファーが小さすぎました。バッファーの内容は未定義です。

解説

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

要件

要件 値

クライアント

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

サーバー

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

ヘッダー

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

ライブラリ

ESENT.lib を使用します。

DLL

ESENT.dll が必要です。

Unicode

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

関連項目

JET_COLUMNID
JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JET_INDEXCREATE
JET_INDEXCREATE2 JET_INDEXID
JET_INDEXLIST JetGetIndexInfo

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 JetGetTableIndexInfoW(
    JET_SESID sesid,
    JET_TABLEID tableid,
    WORD* szIndexName,   // optional
    void* pvResult,
    DWORD cbResult,
    DWORD InfoLevel
);
[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetGetTableIndexInfoW(
    UIntPtr sesid,   // JET_SESID
    UIntPtr tableid,   // JET_TABLEID
    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 JetGetTableIndexInfoW(
    sesid As UIntPtr,   ' JET_SESID
    tableid As UIntPtr,   ' JET_TABLEID
    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
' tableid : JET_TABLEID
' szIndexName : WORD* optional
' pvResult : void* out
' cbResult : DWORD
' InfoLevel : DWORD
Declare PtrSafe Function JetGetTableIndexInfoW Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal tableid As LongPtr, _
    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

JetGetTableIndexInfoW = ctypes.windll.esent.JetGetTableIndexInfoW
JetGetTableIndexInfoW.restype = ctypes.c_int
JetGetTableIndexInfoW.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    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')
JetGetTableIndexInfoW = Fiddle::Function.new(
  lib['JetGetTableIndexInfoW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    Fiddle::TYPE_UINTPTR_T,  # tableid : JET_TABLEID
    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 JetGetTableIndexInfoW(
        sesid: usize,  // JET_SESID
        tableid: usize,  // JET_TABLEID
        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 JetGetTableIndexInfoW(UIntPtr sesid, UIntPtr tableid, IntPtr szIndexName, IntPtr pvResult, uint cbResult, uint InfoLevel);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetGetTableIndexInfoW' -Namespace Win32 -PassThru
# $api::JetGetTableIndexInfoW(sesid, tableid, szIndexName, pvResult, cbResult, InfoLevel)
#uselib "ESENT.dll"
#func global JetGetTableIndexInfoW "JetGetTableIndexInfoW" wptr, wptr, wptr, wptr, wptr, wptr
; JetGetTableIndexInfoW sesid, tableid, varptr(szIndexName), pvResult, cbResult, InfoLevel   ; 戻り値は stat
; sesid : JET_SESID -> "wptr"
; tableid : JET_TABLEID -> "wptr"
; szIndexName : WORD* optional -> "wptr"
; pvResult : void* out -> "wptr"
; cbResult : DWORD -> "wptr"
; InfoLevel : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ESENT.dll"
#cfunc global JetGetTableIndexInfoW "JetGetTableIndexInfoW" sptr, sptr, var, sptr, int, int
; res = JetGetTableIndexInfoW(sesid, tableid, szIndexName, pvResult, cbResult, InfoLevel)
; sesid : JET_SESID -> "sptr"
; tableid : JET_TABLEID -> "sptr"
; szIndexName : WORD* optional -> "var"
; pvResult : void* out -> "sptr"
; cbResult : DWORD -> "int"
; InfoLevel : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT JetGetTableIndexInfoW(JET_SESID sesid, JET_TABLEID tableid, WORD* szIndexName, void* pvResult, DWORD cbResult, DWORD InfoLevel)
#uselib "ESENT.dll"
#cfunc global JetGetTableIndexInfoW "JetGetTableIndexInfoW" intptr, intptr, var, intptr, int, int
; res = JetGetTableIndexInfoW(sesid, tableid, szIndexName, pvResult, cbResult, InfoLevel)
; sesid : JET_SESID -> "intptr"
; tableid : JET_TABLEID -> "intptr"
; szIndexName : WORD* optional -> "var"
; pvResult : void* out -> "intptr"
; cbResult : DWORD -> "int"
; InfoLevel : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetGetTableIndexInfoW = esent.NewProc("JetGetTableIndexInfoW")
)

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

extern "esent" fn JetGetTableIndexInfoW(
    sesid: usize, // JET_SESID
    tableid: usize, // JET_TABLEID
    szIndexName: [*c]u16, // WORD* optional
    pvResult: ?*anyopaque, // void* out
    cbResult: u32, // DWORD
    InfoLevel: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc JetGetTableIndexInfoW(
    sesid: uint,  # JET_SESID
    tableid: uint,  # JET_TABLEID
    szIndexName: ptr uint16,  # WORD* optional
    pvResult: pointer,  # void* out
    cbResult: uint32,  # DWORD
    InfoLevel: uint32  # DWORD
): int32 {.importc: "JetGetTableIndexInfoW", stdcall, dynlib: "ESENT.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "esent");
extern(Windows)
int JetGetTableIndexInfoW(
    size_t sesid,   // JET_SESID
    size_t tableid,   // JET_TABLEID
    ushort* szIndexName,   // WORD* optional
    void* pvResult,   // void* out
    uint cbResult,   // DWORD
    uint InfoLevel   // DWORD
);
ccall((:JetGetTableIndexInfoW, "ESENT.dll"), stdcall, Int32,
      (Csize_t, Csize_t, Ptr{UInt16}, Ptr{Cvoid}, UInt32, UInt32),
      sesid, tableid, szIndexName, pvResult, cbResult, InfoLevel)
# sesid : JET_SESID -> Csize_t
# tableid : JET_TABLEID -> Csize_t
# szIndexName : WORD* optional -> Ptr{UInt16}
# pvResult : void* out -> Ptr{Cvoid}
# cbResult : DWORD -> UInt32
# InfoLevel : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetGetTableIndexInfoW(
    uintptr_t sesid,
    uintptr_t tableid,
    uint16_t* szIndexName,
    void* pvResult,
    uint32_t cbResult,
    uint32_t InfoLevel);
]]
local esent = ffi.load("esent")
-- esent.JetGetTableIndexInfoW(sesid, tableid, szIndexName, pvResult, cbResult, InfoLevel)
-- sesid : JET_SESID
-- tableid : JET_TABLEID
-- szIndexName : WORD* optional
-- pvResult : void* out
-- cbResult : DWORD
-- InfoLevel : DWORD
-- 構造体/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 JetGetTableIndexInfoW = lib.func('__stdcall', 'JetGetTableIndexInfoW', 'int32_t', ['uintptr_t', 'uintptr_t', 'uint16_t *', 'void *', 'uint32_t', 'uint32_t']);
// JetGetTableIndexInfoW(sesid, tableid, szIndexName, pvResult, cbResult, InfoLevel)
// sesid : JET_SESID -> 'uintptr_t'
// tableid : JET_TABLEID -> 'uintptr_t'
// szIndexName : WORD* optional -> 'uint16_t *'
// pvResult : void* out -> 'void *'
// cbResult : DWORD -> 'uint32_t'
// InfoLevel : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetGetTableIndexInfoW: { parameters: ["usize", "usize", "pointer", "pointer", "u32", "u32"], result: "i32" },
});
// lib.symbols.JetGetTableIndexInfoW(sesid, tableid, szIndexName, pvResult, cbResult, InfoLevel)
// sesid : JET_SESID -> "usize"
// tableid : JET_TABLEID -> "usize"
// szIndexName : WORD* optional -> "pointer"
// pvResult : void* out -> "pointer"
// cbResult : DWORD -> "u32"
// InfoLevel : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetGetTableIndexInfoW(
    size_t sesid,
    size_t tableid,
    uint16_t* szIndexName,
    void* pvResult,
    uint32_t cbResult,
    uint32_t InfoLevel);
C, "ESENT.dll");
// $ffi->JetGetTableIndexInfoW(sesid, tableid, szIndexName, pvResult, cbResult, InfoLevel);
// sesid : JET_SESID
// tableid : JET_TABLEID
// szIndexName : WORD* optional
// pvResult : void* out
// cbResult : DWORD
// InfoLevel : 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, W32APIOptions.UNICODE_OPTIONS);
    int JetGetTableIndexInfoW(
        long sesid,   // JET_SESID
        long tableid,   // JET_TABLEID
        ShortByReference szIndexName,   // WORD* optional
        Pointer pvResult,   // void* out
        int cbResult,   // DWORD
        int InfoLevel   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("esent")]
lib LibESENT
  fun JetGetTableIndexInfoW = JetGetTableIndexInfoW(
    sesid : LibC::SizeT,   # JET_SESID
    tableid : LibC::SizeT,   # JET_TABLEID
    szIndexName : UInt16*,   # WORD* optional
    pvResult : Void*,   # void* out
    cbResult : UInt32,   # DWORD
    InfoLevel : 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 JetGetTableIndexInfoWNative = Int32 Function(UintPtr, UintPtr, Pointer<Uint16>, Pointer<Void>, Uint32, Uint32);
typedef JetGetTableIndexInfoWDart = int Function(int, int, Pointer<Uint16>, Pointer<Void>, int, int);
final JetGetTableIndexInfoW = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetGetTableIndexInfoWNative, JetGetTableIndexInfoWDart>('JetGetTableIndexInfoW');
// sesid : JET_SESID -> UintPtr
// tableid : JET_TABLEID -> UintPtr
// szIndexName : WORD* optional -> Pointer<Uint16>
// pvResult : void* out -> Pointer<Void>
// cbResult : DWORD -> Uint32
// InfoLevel : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetGetTableIndexInfoW(
  sesid: NativeUInt;   // JET_SESID
  tableid: NativeUInt;   // JET_TABLEID
  szIndexName: Pointer;   // WORD* optional
  pvResult: Pointer;   // void* out
  cbResult: DWORD;   // DWORD
  InfoLevel: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetTableIndexInfoW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let jetgettableindexinfow =
  foreign "JetGetTableIndexInfoW"
    (size_t @-> size_t @-> (ptr uint16_t) @-> (ptr void) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* tableid : JET_TABLEID -> size_t *)
(* szIndexName : WORD* optional -> (ptr uint16_t) *)
(* pvResult : void* out -> (ptr void) *)
(* cbResult : DWORD -> uint32_t *)
(* InfoLevel : 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 ("JetGetTableIndexInfoW" jet-get-table-index-info-w :convention :stdcall) :int32
  (sesid :uint64)   ; JET_SESID
  (tableid :uint64)   ; JET_TABLEID
  (sz-index-name :pointer)   ; WORD* optional
  (pv-result :pointer)   ; void* out
  (cb-result :uint32)   ; DWORD
  (info-level :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetGetTableIndexInfoW = Win32::API::More->new('ESENT',
    'int JetGetTableIndexInfoW(WPARAM sesid, WPARAM tableid, LPVOID szIndexName, LPVOID pvResult, DWORD cbResult, DWORD InfoLevel)');
# my $ret = $JetGetTableIndexInfoW->Call($sesid, $tableid, $szIndexName, $pvResult, $cbResult, $InfoLevel);
# sesid : JET_SESID -> WPARAM
# tableid : JET_TABLEID -> WPARAM
# szIndexName : WORD* optional -> LPVOID
# pvResult : void* out -> LPVOID
# cbResult : DWORD -> DWORD
# InfoLevel : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い