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

JetGetTableInfoW

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

シグネチャ

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

INT JetGetTableInfoW(
    JET_SESID sesid,
    JET_TABLEID tableid,
    void* pvResult,
    DWORD cbMax,
    DWORD InfoLevel
);

パラメーター

名前型方向説明
sesidJET_SESIDin操作に使用するセッションID。
tableidJET_TABLEIDin情報を取得する対象テーブルのカーソルID。
pvResultvoid*out取得したテーブル情報を受け取る出力バッファへのポインタ。
cbMaxDWORDinpvResultバッファのバイトサイズ。
InfoLevelDWORDin取得する情報レベル(JET_TblInfo系定数)。

戻り値の型: INT

公式ドキュメント

JetGetTableInfo 関数は、データベース内のテーブルに関するさまざまな情報を取得します。

戻り値

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

戻りコード

説明

JET_errSuccess

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

JET_errBufferTooSmall

バッファーが小さすぎました。

JET_errFeatureNotAvailable

非推奨の InfoLevel が指定されました。

JET_errInvalidBufferSize

バッファーのサイズが正しくありませんでした。

JET_errInvalidOperation

渡されたテーブルが一時テーブルであり、要求された InfoLevel は一時テーブルに対しては取得できません。

JET_errObjectNotFound

渡されたテーブルが一時テーブルであり、要求された InfoLevel は一時テーブルに対しては取得できません。

JET_errQueryNotSupported

InfoLevel はサポートされていません。

JET_errTableInUse

テーブルは別のデータベース操作によって使用されています。

JET_errTableLocked

テーブルは別のデータベース操作によってロックされています。

JET_wrnTableInUseBySystem

テーブルはシステムによって使用されています。この警告は致命的ではありません。

解説

一部の情報は一時テーブルには有効ではありません (JetOpenTempTable を参照してください)。

テーブルの統計情報には、レコード数と、クラスター化インデックス (つまり、レコードデータを格納するインデックス) 内のページ数が含まれます。インデックスの統計情報には、JetGetIndexInfo または JetGetTableIndexInfo を使用して、名前を指定して個別にアクセスします。

要件

要件 値

クライアント

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

サーバー

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

ヘッダー

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

ライブラリ

ESENT.lib を使用します。

DLL

ESENT.dll が必要です。

Unicode

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

関連項目

JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JET_OBJECTINFO
JetGetIndexInfo
JetGetObjectInfo
JetGetTableIndexInfo
JetOpenTempTable

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

JetGetTableInfoW = ctypes.windll.esent.JetGetTableInfoW
JetGetTableInfoW.restype = ctypes.c_int
JetGetTableInfoW.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.c_size_t,  # tableid : JET_TABLEID
    ctypes.POINTER(None),  # pvResult : void* out
    wintypes.DWORD,  # cbMax : DWORD
    wintypes.DWORD,  # InfoLevel : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetGetTableInfoW = Fiddle::Function.new(
  lib['JetGetTableInfoW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    Fiddle::TYPE_UINTPTR_T,  # tableid : JET_TABLEID
    Fiddle::TYPE_VOIDP,  # pvResult : void* out
    -Fiddle::TYPE_INT,  # cbMax : DWORD
    -Fiddle::TYPE_INT,  # InfoLevel : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "esent")]
extern "system" {
    fn JetGetTableInfoW(
        sesid: usize,  // JET_SESID
        tableid: usize,  // JET_TABLEID
        pvResult: *mut (),  // void* out
        cbMax: 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 JetGetTableInfoW(UIntPtr sesid, UIntPtr tableid, IntPtr pvResult, uint cbMax, uint InfoLevel);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetGetTableInfoW' -Namespace Win32 -PassThru
# $api::JetGetTableInfoW(sesid, tableid, pvResult, cbMax, InfoLevel)
#uselib "ESENT.dll"
#func global JetGetTableInfoW "JetGetTableInfoW" wptr, wptr, wptr, wptr, wptr
; JetGetTableInfoW sesid, tableid, pvResult, cbMax, InfoLevel   ; 戻り値は stat
; sesid : JET_SESID -> "wptr"
; tableid : JET_TABLEID -> "wptr"
; pvResult : void* out -> "wptr"
; cbMax : DWORD -> "wptr"
; InfoLevel : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ESENT.dll"
#cfunc global JetGetTableInfoW "JetGetTableInfoW" sptr, sptr, sptr, int, int
; res = JetGetTableInfoW(sesid, tableid, pvResult, cbMax, InfoLevel)
; sesid : JET_SESID -> "sptr"
; tableid : JET_TABLEID -> "sptr"
; pvResult : void* out -> "sptr"
; cbMax : DWORD -> "int"
; InfoLevel : DWORD -> "int"
; INT JetGetTableInfoW(JET_SESID sesid, JET_TABLEID tableid, void* pvResult, DWORD cbMax, DWORD InfoLevel)
#uselib "ESENT.dll"
#cfunc global JetGetTableInfoW "JetGetTableInfoW" intptr, intptr, intptr, int, int
; res = JetGetTableInfoW(sesid, tableid, pvResult, cbMax, InfoLevel)
; sesid : JET_SESID -> "intptr"
; tableid : JET_TABLEID -> "intptr"
; pvResult : void* out -> "intptr"
; cbMax : DWORD -> "int"
; InfoLevel : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetGetTableInfoW = esent.NewProc("JetGetTableInfoW")
)

// sesid (JET_SESID), tableid (JET_TABLEID), pvResult (void* out), cbMax (DWORD), InfoLevel (DWORD)
r1, _, err := procJetGetTableInfoW.Call(
	uintptr(sesid),
	uintptr(tableid),
	uintptr(pvResult),
	uintptr(cbMax),
	uintptr(InfoLevel),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function JetGetTableInfoW(
  sesid: NativeUInt;   // JET_SESID
  tableid: NativeUInt;   // JET_TABLEID
  pvResult: Pointer;   // void* out
  cbMax: DWORD;   // DWORD
  InfoLevel: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetTableInfoW';
result := DllCall("ESENT\JetGetTableInfoW"
    , "UPtr", sesid   ; JET_SESID
    , "UPtr", tableid   ; JET_TABLEID
    , "Ptr", pvResult   ; void* out
    , "UInt", cbMax   ; DWORD
    , "UInt", InfoLevel   ; DWORD
    , "Int")   ; return: INT
●JetGetTableInfoW(sesid, tableid, pvResult, cbMax, InfoLevel) = DLL("ESENT.dll", "int JetGetTableInfoW(int, int, void*, dword, dword)")
# 呼び出し: JetGetTableInfoW(sesid, tableid, pvResult, cbMax, InfoLevel)
# sesid : JET_SESID -> "int"
# tableid : JET_TABLEID -> "int"
# pvResult : void* out -> "void*"
# cbMax : 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 JetGetTableInfoW(
    sesid: usize, // JET_SESID
    tableid: usize, // JET_TABLEID
    pvResult: ?*anyopaque, // void* out
    cbMax: u32, // DWORD
    InfoLevel: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc JetGetTableInfoW(
    sesid: uint,  # JET_SESID
    tableid: uint,  # JET_TABLEID
    pvResult: pointer,  # void* out
    cbMax: uint32,  # DWORD
    InfoLevel: uint32  # DWORD
): int32 {.importc: "JetGetTableInfoW", stdcall, dynlib: "ESENT.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "esent");
extern(Windows)
int JetGetTableInfoW(
    size_t sesid,   // JET_SESID
    size_t tableid,   // JET_TABLEID
    void* pvResult,   // void* out
    uint cbMax,   // DWORD
    uint InfoLevel   // DWORD
);
ccall((:JetGetTableInfoW, "ESENT.dll"), stdcall, Int32,
      (Csize_t, Csize_t, Ptr{Cvoid}, UInt32, UInt32),
      sesid, tableid, pvResult, cbMax, InfoLevel)
# sesid : JET_SESID -> Csize_t
# tableid : JET_TABLEID -> Csize_t
# pvResult : void* out -> Ptr{Cvoid}
# cbMax : DWORD -> UInt32
# InfoLevel : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetGetTableInfoW(
    uintptr_t sesid,
    uintptr_t tableid,
    void* pvResult,
    uint32_t cbMax,
    uint32_t InfoLevel);
]]
local esent = ffi.load("esent")
-- esent.JetGetTableInfoW(sesid, tableid, pvResult, cbMax, InfoLevel)
-- sesid : JET_SESID
-- tableid : JET_TABLEID
-- pvResult : void* out
-- cbMax : 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 JetGetTableInfoW = lib.func('__stdcall', 'JetGetTableInfoW', 'int32_t', ['uintptr_t', 'uintptr_t', 'void *', 'uint32_t', 'uint32_t']);
// JetGetTableInfoW(sesid, tableid, pvResult, cbMax, InfoLevel)
// sesid : JET_SESID -> 'uintptr_t'
// tableid : JET_TABLEID -> 'uintptr_t'
// pvResult : void* out -> 'void *'
// cbMax : DWORD -> 'uint32_t'
// InfoLevel : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetGetTableInfoW: { parameters: ["usize", "usize", "pointer", "u32", "u32"], result: "i32" },
});
// lib.symbols.JetGetTableInfoW(sesid, tableid, pvResult, cbMax, InfoLevel)
// sesid : JET_SESID -> "usize"
// tableid : JET_TABLEID -> "usize"
// pvResult : void* out -> "pointer"
// cbMax : 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 JetGetTableInfoW(
    size_t sesid,
    size_t tableid,
    void* pvResult,
    uint32_t cbMax,
    uint32_t InfoLevel);
C, "ESENT.dll");
// $ffi->JetGetTableInfoW(sesid, tableid, pvResult, cbMax, InfoLevel);
// sesid : JET_SESID
// tableid : JET_TABLEID
// pvResult : void* out
// cbMax : 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 JetGetTableInfoW(
        long sesid,   // JET_SESID
        long tableid,   // JET_TABLEID
        Pointer pvResult,   // void* out
        int cbMax,   // DWORD
        int InfoLevel   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("esent")]
lib LibESENT
  fun JetGetTableInfoW = JetGetTableInfoW(
    sesid : LibC::SizeT,   # JET_SESID
    tableid : LibC::SizeT,   # JET_TABLEID
    pvResult : Void*,   # void* out
    cbMax : 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 JetGetTableInfoWNative = Int32 Function(UintPtr, UintPtr, Pointer<Void>, Uint32, Uint32);
typedef JetGetTableInfoWDart = int Function(int, int, Pointer<Void>, int, int);
final JetGetTableInfoW = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetGetTableInfoWNative, JetGetTableInfoWDart>('JetGetTableInfoW');
// sesid : JET_SESID -> UintPtr
// tableid : JET_TABLEID -> UintPtr
// pvResult : void* out -> Pointer<Void>
// cbMax : DWORD -> Uint32
// InfoLevel : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetGetTableInfoW(
  sesid: NativeUInt;   // JET_SESID
  tableid: NativeUInt;   // JET_TABLEID
  pvResult: Pointer;   // void* out
  cbMax: DWORD;   // DWORD
  InfoLevel: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetGetTableInfoW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

関連項目

文字セット違い