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

各言語での呼び出し定義

// 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(変数))。

出力引数:

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

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetGetIndexInfoW = esent.NewProc("JetGetIndexInfoW")
)

// sesid (JET_SESID), dbid (DWORD), szTableName (WORD*), szIndexName (WORD* optional), pvResult (void* out), cbResult (DWORD), InfoLevel (DWORD)
r1, _, err := procJetGetIndexInfoW.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 JetGetIndexInfoW(
  sesid: NativeUInt;   // JET_SESID
  dbid: DWORD;   // DWORD
  szTableName: Pointer;   // WORD*
  szIndexName: Pointer;   // WORD* optional
  pvResult: Pointer;   // void* out
  cbResult: DWORD;   // DWORD
  InfoLevel: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetIndexInfoW';

result := DllCall("ESENT\JetGetIndexInfoW"
    , "UPtr", sesid   ; JET_SESID
    , "UInt", dbid   ; DWORD
    , "Ptr", szTableName   ; WORD*
    , "Ptr", szIndexName   ; WORD* optional
    , "Ptr", pvResult   ; void* out
    , "UInt", cbResult   ; DWORD
    , "UInt", InfoLevel   ; DWORD
    , "Int")   ; return: INT

●JetGetIndexInfoW(sesid, dbid, szTableName, szIndexName, pvResult, cbResult, InfoLevel) = DLL("ESENT.dll", "int JetGetIndexInfoW(int, dword, void*, void*, void*, dword, dword)")
# 呼び出し: JetGetIndexInfoW(sesid, dbid, szTableName, szIndexName, pvResult, cbResult, InfoLevel)
# sesid : JET_SESID -> "int"
# dbid : DWORD -> "dword"
# szTableName : WORD* -> "void*"
# 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 JetGetIndexInfoW(
    sesid: usize, // JET_SESID
    dbid: u32, // DWORD
    szTableName: [*c]u16, // WORD*
    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 JetGetIndexInfoW(
    sesid: uint,  # JET_SESID
    dbid: uint32,  # DWORD
    szTableName: ptr uint16,  # WORD*
    szIndexName: ptr uint16,  # WORD* optional
    pvResult: pointer,  # void* out
    cbResult: uint32,  # DWORD
    InfoLevel: uint32  # DWORD
): int32 {.importc: "JetGetIndexInfoW", stdcall, dynlib: "ESENT.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。

pragma(lib, "esent");
extern(Windows)
int JetGetIndexInfoW(
    size_t sesid,   // JET_SESID
    uint dbid,   // DWORD
    ushort* szTableName,   // WORD*
    ushort* szIndexName,   // WORD* optional
    void* pvResult,   // void* out
    uint cbResult,   // DWORD
    uint InfoLevel   // DWORD
);

ccall((:JetGetIndexInfoW, "ESENT.dll"), stdcall, Int32,
      (Csize_t, UInt32, Ptr{UInt16}, Ptr{UInt16}, Ptr{Cvoid}, UInt32, UInt32),
      sesid, dbid, szTableName, szIndexName, pvResult, cbResult, InfoLevel)
# sesid : JET_SESID -> Csize_t
# dbid : DWORD -> UInt32
# szTableName : WORD* -> Ptr{UInt16}
# 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 JetGetIndexInfoW(
    uintptr_t sesid,
    uint32_t dbid,
    uint16_t* szTableName,
    uint16_t* szIndexName,
    void* pvResult,
    uint32_t cbResult,
    uint32_t InfoLevel);
]]
local esent = ffi.load("esent")
-- esent.JetGetIndexInfoW(sesid, dbid, szTableName, szIndexName, pvResult, cbResult, InfoLevel)
-- sesid : JET_SESID
-- dbid : DWORD
-- szTableName : WORD*
-- 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 JetGetIndexInfoW = lib.func('__stdcall', 'JetGetIndexInfoW', 'int32_t', ['uintptr_t', 'uint32_t', 'uint16_t *', 'uint16_t *', 'void *', 'uint32_t', 'uint32_t']);
// JetGetIndexInfoW(sesid, dbid, szTableName, szIndexName, pvResult, cbResult, InfoLevel)
// sesid : JET_SESID -> 'uintptr_t'
// dbid : DWORD -> 'uint32_t'
// szTableName : WORD* -> 'uint16_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", {
  JetGetIndexInfoW: { parameters: ["usize", "u32", "pointer", "pointer", "pointer", "u32", "u32"], result: "i32" },
});
// lib.symbols.JetGetIndexInfoW(sesid, dbid, szTableName, szIndexName, pvResult, cbResult, InfoLevel)
// sesid : JET_SESID -> "usize"
// dbid : DWORD -> "u32"
// szTableName : WORD* -> "pointer"
// 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 JetGetIndexInfoW(
    size_t sesid,
    uint32_t dbid,
    uint16_t* szTableName,
    uint16_t* szIndexName,
    void* pvResult,
    uint32_t cbResult,
    uint32_t InfoLevel);
C, "ESENT.dll");
// $ffi->JetGetIndexInfoW(sesid, dbid, szTableName, szIndexName, pvResult, cbResult, InfoLevel);
// sesid : JET_SESID
// dbid : DWORD
// szTableName : WORD*
// 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 JetGetIndexInfoW(
        long sesid,   // JET_SESID
        int dbid,   // DWORD
        ShortByReference szTableName,   // WORD*
        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 JetGetIndexInfoW = JetGetIndexInfoW(
    sesid : LibC::SizeT,   # JET_SESID
    dbid : UInt32,   # DWORD
    szTableName : UInt16*,   # WORD*
    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 JetGetIndexInfoWNative = Int32 Function(UintPtr, Uint32, Pointer<Uint16>, Pointer<Uint16>, Pointer<Void>, Uint32, Uint32);
typedef JetGetIndexInfoWDart = int Function(int, int, Pointer<Uint16>, Pointer<Uint16>, Pointer<Void>, int, int);
final JetGetIndexInfoW = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetGetIndexInfoWNative, JetGetIndexInfoWDart>('JetGetIndexInfoW');
// sesid : JET_SESID -> UintPtr
// dbid : DWORD -> Uint32
// szTableName : WORD* -> Pointer<Uint16>
// szIndexName : WORD* optional -> Pointer<Uint16>
// pvResult : void* out -> Pointer<Void>
// cbResult : DWORD -> Uint32
// InfoLevel : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function JetGetIndexInfoW(
  sesid: NativeUInt;   // JET_SESID
  dbid: DWORD;   // DWORD
  szTableName: Pointer;   // WORD*
  szIndexName: Pointer;   // WORD* optional
  pvResult: Pointer;   // void* out
  cbResult: DWORD;   // DWORD
  InfoLevel: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetIndexInfoW';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetGetIndexInfoW"
  c_JetGetIndexInfoW :: CUIntPtr -> Word32 -> Ptr Word16 -> Ptr Word16 -> Ptr () -> Word32 -> Word32 -> IO Int32
-- sesid : JET_SESID -> CUIntPtr
-- dbid : DWORD -> Word32
-- szTableName : WORD* -> Ptr Word16
-- 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 jetgetindexinfow =
  foreign "JetGetIndexInfoW"
    (size_t @-> uint32_t @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* dbid : DWORD -> uint32_t *)
(* szTableName : WORD* -> (ptr uint16_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 ("JetGetIndexInfoW" jet-get-index-info-w :convention :stdcall) :int32
  (sesid :uint64)   ; JET_SESID
  (dbid :uint32)   ; DWORD
  (sz-table-name :pointer)   ; WORD*
  (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 $JetGetIndexInfoW = Win32::API::More->new('ESENT',
    'int JetGetIndexInfoW(WPARAM sesid, DWORD dbid, LPVOID szTableName, LPVOID szIndexName, LPVOID pvResult, DWORD cbResult, DWORD InfoLevel)');
# my $ret = $JetGetIndexInfoW->Call($sesid, $dbid, $szTableName, $szIndexName, $pvResult, $cbResult, $InfoLevel);
# sesid : JET_SESID -> WPARAM
# dbid : DWORD -> DWORD
# szTableName : WORD* -> LPVOID
# 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 変換を行う。

JetGetIndexInfoW

シグネチャ

パラメーター

各言語での呼び出し定義

関連項目