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

JetGetIndexInfoA

関数
テーブル名とインデックス名からインデックス情報を取得する(ANSI版)。
DLLESENT.dll文字セットANSI (-A)呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

// 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
);

パラメーター

名前型方向説明
sesidJET_SESIDin操作に使用するセッションID。
dbidDWORDin対象テーブルを含むデータベースのID。
szTableNameCHAR*in対象テーブル名を指すANSI文字列。
szIndexNameCHAR*inoptional情報を取得するインデックス名を指すANSI文字列。NULL可。
pvResultvoid*out取得したインデックス情報を受け取る出力バッファへのポインタ。
cbResultDWORDinpvResultバッファのバイトサイズ。
InfoLevelDWORDin取得する情報レベル(JET_IdxInfo系定数)。

戻り値の型: INT

各言語での呼び出し定義

// 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 方式にも切替可。
出力引数: 
; INT JetGetIndexInfoA(JET_SESID sesid, DWORD dbid, CHAR* szTableName, CHAR* szIndexName, void* pvResult, DWORD cbResult, DWORD InfoLevel)
#uselib "ESENT.dll"
#cfunc global JetGetIndexInfoA "JetGetIndexInfoA" intptr, int, var, var, intptr, int, int
; res = JetGetIndexInfoA(sesid, dbid, szTableName, szIndexName, pvResult, cbResult, InfoLevel)
; sesid : JET_SESID -> "intptr"
; dbid : DWORD -> "int"
; szTableName : CHAR* -> "var"
; szIndexName : CHAR* 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")
	procJetGetIndexInfoA = esent.NewProc("JetGetIndexInfoA")
)

// sesid (JET_SESID), dbid (DWORD), szTableName (CHAR*), szIndexName (CHAR* optional), pvResult (void* out), cbResult (DWORD), InfoLevel (DWORD)
r1, _, err := procJetGetIndexInfoA.Call(
	uintptr(sesid),
	uintptr(dbid),
	uintptr(szTableName),
	uintptr(szIndexName),
	uintptr(pvResult),
	uintptr(cbResult),
	uintptr(InfoLevel),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function JetGetIndexInfoA(
  sesid: NativeUInt;   // JET_SESID
  dbid: DWORD;   // DWORD
  szTableName: Pointer;   // CHAR*
  szIndexName: Pointer;   // CHAR* optional
  pvResult: Pointer;   // void* out
  cbResult: DWORD;   // DWORD
  InfoLevel: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetIndexInfoA';
result := DllCall("ESENT\JetGetIndexInfoA"
    , "UPtr", sesid   ; JET_SESID
    , "UInt", dbid   ; DWORD
    , "Ptr", szTableName   ; CHAR*
    , "Ptr", szIndexName   ; CHAR* optional
    , "Ptr", pvResult   ; void* out
    , "UInt", cbResult   ; DWORD
    , "UInt", InfoLevel   ; DWORD
    , "Int")   ; return: INT
●JetGetIndexInfoA(sesid, dbid, szTableName, szIndexName, pvResult, cbResult, InfoLevel) = DLL("ESENT.dll", "int JetGetIndexInfoA(int, dword, void*, void*, void*, dword, dword)")
# 呼び出し: JetGetIndexInfoA(sesid, dbid, szTableName, szIndexName, pvResult, cbResult, InfoLevel)
# sesid : JET_SESID -> "int"
# dbid : DWORD -> "dword"
# szTableName : CHAR* -> "void*"
# szIndexName : CHAR* optional -> "void*"
# pvResult : void* out -> "void*"
# cbResult : DWORD -> "dword"
# InfoLevel : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "esent" fn JetGetIndexInfoA(
    sesid: usize, // JET_SESID
    dbid: u32, // DWORD
    szTableName: [*c]i8, // CHAR*
    szIndexName: [*c]i8, // CHAR* optional
    pvResult: ?*anyopaque, // void* out
    cbResult: u32, // DWORD
    InfoLevel: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc JetGetIndexInfoA(
    sesid: uint,  # JET_SESID
    dbid: uint32,  # DWORD
    szTableName: ptr int8,  # CHAR*
    szIndexName: ptr int8,  # CHAR* optional
    pvResult: pointer,  # void* out
    cbResult: uint32,  # DWORD
    InfoLevel: uint32  # DWORD
): int32 {.importc: "JetGetIndexInfoA", stdcall, dynlib: "ESENT.dll".}
pragma(lib, "esent");
extern(Windows)
int JetGetIndexInfoA(
    size_t sesid,   // JET_SESID
    uint dbid,   // DWORD
    byte* szTableName,   // CHAR*
    byte* szIndexName,   // CHAR* optional
    void* pvResult,   // void* out
    uint cbResult,   // DWORD
    uint InfoLevel   // DWORD
);
ccall((:JetGetIndexInfoA, "ESENT.dll"), stdcall, Int32,
      (Csize_t, UInt32, Ptr{Int8}, Ptr{Int8}, Ptr{Cvoid}, UInt32, UInt32),
      sesid, dbid, szTableName, szIndexName, pvResult, cbResult, InfoLevel)
# sesid : JET_SESID -> Csize_t
# dbid : DWORD -> UInt32
# szTableName : CHAR* -> Ptr{Int8}
# szIndexName : CHAR* optional -> Ptr{Int8}
# pvResult : void* out -> Ptr{Cvoid}
# cbResult : DWORD -> UInt32
# InfoLevel : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetGetIndexInfoA(
    uintptr_t sesid,
    uint32_t dbid,
    int8_t* szTableName,
    int8_t* szIndexName,
    void* pvResult,
    uint32_t cbResult,
    uint32_t InfoLevel);
]]
local esent = ffi.load("esent")
-- esent.JetGetIndexInfoA(sesid, dbid, szTableName, szIndexName, pvResult, cbResult, InfoLevel)
-- sesid : JET_SESID
-- dbid : DWORD
-- szTableName : CHAR*
-- szIndexName : CHAR* optional
-- pvResult : void* out
-- cbResult : DWORD
-- InfoLevel : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetGetIndexInfoA = lib.func('__stdcall', 'JetGetIndexInfoA', 'int32_t', ['uintptr_t', 'uint32_t', 'int8_t *', 'int8_t *', 'void *', 'uint32_t', 'uint32_t']);
// JetGetIndexInfoA(sesid, dbid, szTableName, szIndexName, pvResult, cbResult, InfoLevel)
// sesid : JET_SESID -> 'uintptr_t'
// dbid : DWORD -> 'uint32_t'
// szTableName : CHAR* -> 'int8_t *'
// szIndexName : CHAR* optional -> 'int8_t *'
// pvResult : void* out -> 'void *'
// cbResult : DWORD -> 'uint32_t'
// InfoLevel : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetGetIndexInfoA: { parameters: ["usize", "u32", "pointer", "pointer", "pointer", "u32", "u32"], result: "i32" },
});
// lib.symbols.JetGetIndexInfoA(sesid, dbid, szTableName, szIndexName, pvResult, cbResult, InfoLevel)
// sesid : JET_SESID -> "usize"
// dbid : DWORD -> "u32"
// szTableName : CHAR* -> "pointer"
// szIndexName : CHAR* optional -> "pointer"
// pvResult : void* out -> "pointer"
// cbResult : DWORD -> "u32"
// InfoLevel : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetGetIndexInfoA(
    size_t sesid,
    uint32_t dbid,
    int8_t* szTableName,
    int8_t* szIndexName,
    void* pvResult,
    uint32_t cbResult,
    uint32_t InfoLevel);
C, "ESENT.dll");
// $ffi->JetGetIndexInfoA(sesid, dbid, szTableName, szIndexName, pvResult, cbResult, InfoLevel);
// sesid : JET_SESID
// dbid : DWORD
// szTableName : CHAR*
// szIndexName : CHAR* 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.ASCII_OPTIONS);
    int JetGetIndexInfoA(
        long sesid,   // JET_SESID
        int dbid,   // DWORD
        byte[] szTableName,   // CHAR*
        byte[] szIndexName,   // CHAR* optional
        Pointer pvResult,   // void* out
        int cbResult,   // DWORD
        int InfoLevel   // DWORD
    );
}
@[Link("esent")]
lib LibESENT
  fun JetGetIndexInfoA = JetGetIndexInfoA(
    sesid : LibC::SizeT,   # JET_SESID
    dbid : UInt32,   # DWORD
    szTableName : Int8*,   # CHAR*
    szIndexName : Int8*,   # CHAR* 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 JetGetIndexInfoANative = Int32 Function(UintPtr, Uint32, Pointer<Int8>, Pointer<Int8>, Pointer<Void>, Uint32, Uint32);
typedef JetGetIndexInfoADart = int Function(int, int, Pointer<Int8>, Pointer<Int8>, Pointer<Void>, int, int);
final JetGetIndexInfoA = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetGetIndexInfoANative, JetGetIndexInfoADart>('JetGetIndexInfoA');
// sesid : JET_SESID -> UintPtr
// dbid : DWORD -> Uint32
// szTableName : CHAR* -> Pointer<Int8>
// szIndexName : CHAR* optional -> Pointer<Int8>
// pvResult : void* out -> Pointer<Void>
// cbResult : DWORD -> Uint32
// InfoLevel : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetGetIndexInfoA(
  sesid: NativeUInt;   // JET_SESID
  dbid: DWORD;   // DWORD
  szTableName: Pointer;   // CHAR*
  szIndexName: Pointer;   // CHAR* optional
  pvResult: Pointer;   // void* out
  cbResult: DWORD;   // DWORD
  InfoLevel: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetIndexInfoA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let jetgetindexinfoa =
  foreign "JetGetIndexInfoA"
    (size_t @-> uint32_t @-> (ptr int8_t) @-> (ptr int8_t) @-> (ptr void) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* dbid : DWORD -> uint32_t *)
(* szTableName : CHAR* -> (ptr int8_t) *)
(* szIndexName : CHAR* optional -> (ptr int8_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 ("JetGetIndexInfoA" jet-get-index-info-a :convention :stdcall) :int32
  (sesid :uint64)   ; JET_SESID
  (dbid :uint32)   ; DWORD
  (sz-table-name :pointer)   ; CHAR*
  (sz-index-name :pointer)   ; CHAR* 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 $JetGetIndexInfoA = Win32::API::More->new('ESENT',
    'int JetGetIndexInfoA(WPARAM sesid, DWORD dbid, LPVOID szTableName, LPVOID szIndexName, LPVOID pvResult, DWORD cbResult, DWORD InfoLevel)');
# my $ret = $JetGetIndexInfoA->Call($sesid, $dbid, $szTableName, $szIndexName, $pvResult, $cbResult, $InfoLevel);
# sesid : JET_SESID -> WPARAM
# dbid : DWORD -> DWORD
# szTableName : CHAR* -> LPVOID
# szIndexName : CHAR* optional -> LPVOID
# pvResult : void* out -> LPVOID
# cbResult : DWORD -> DWORD
# InfoLevel : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い