ホーム › Storage.Jet › JetGetDatabaseFileInfoW

JetGetDatabaseFileInfoW

関数

データベースファイルから情報を取得する(Unicode版)。

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

シグネチャ

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

INT JetGetDatabaseFileInfoW(
    WORD* szDatabaseName,
    void* pvResult,
    DWORD cbMax,
    DWORD InfoLevel
);

パラメーター

名前	型	方向	説明
szDatabaseName	WORD*	in	情報取得対象のデータベースファイルのパスを指す終端付きUnicode文字列ポインタ。
pvResult	void*	out	取得した情報を受け取る出力バッファのポインタ。InfoLevelに応じた型で格納される。
cbMax	DWORD	in	pvResultバッファのサイズをバイト単位で指定する値。
InfoLevel	DWORD	in	取得する情報の種類を指定する列挙値。JET_DbInfo系定数で項目を選ぶ。

戻り値の型: INT

公式ドキュメント

JetGetDatabaseFileInfo 関数は、データベースに関するさまざまな種類の情報を取得します。この API は、データベースがアタッチされているかオンラインの状態でも(JetGetDatabaseInfo を使用)、データベースまたはデータベースエンジンがオフラインの状態でも(JetGetDatabaseFileInfo を使用)呼び出すことができます。

戻り値

この関数は JET_ERR データ型を返し、その値は以下のリターンコードのいずれかになります。発生し得る ESE のエラーの詳細については、Extensible Storage Engine のエラーおよびエラー処理パラメーターを参照してください。

リターンコード	説明
JET_errSuccess	操作は正常に完了しました。
JET_errFeatureNotAvailable	要求された InfoLevel が JET_DbInfoIsam でした。これはサポートされていません。
JET_errBufferTooSmall	cbMax で指定されたバッファーが、目的の情報を格納するには小さすぎます。
JET_errInvalidBufferSize	cbMax で指定されたバッファーのサイズが、目的の情報に対して正しくありません。
JET_errInvalidParameter	指定されたパラメーターのいずれかに予期しない値が含まれていたか、複数のパラメーター値の組み合わせによって予期しない結果が生じました。指定された DBID が有効な(アタッチされた)データベースではない場合、このエラーは JetGetDatabaseInfo から返されます。また、要求された InfoLevel がそのバージョンの関数でサポートされていない場合、このエラーは JetGetDatabaseFileInfo および JetGetDatabaseInfo から返されます。

この関数が成功した場合、要求されたデータが出力バッファーに返されます。

この関数が失敗した場合、出力バッファーは未定義の状態になります。

要件

クライアント	Windows Vista、Windows XP、または Windows 2000 Professional が必要です。
サーバー	Windows Server 2008、Windows Server 2003、または Windows 2000 Server が必要です。
ヘッダー	Esent.h で宣言されています。
ライブラリ	ESENT.lib を使用します。
DLL	ESENT.dll が必要です。
Unicode	JetGetDatabaseFileInfoW(Unicode)および JetGetDatabaseFileInfoA(ANSI)として実装されています。

各言語での呼び出し定義

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

INT JetGetDatabaseFileInfoW(
    WORD* szDatabaseName,
    void* pvResult,
    DWORD cbMax,
    DWORD InfoLevel
);

[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetGetDatabaseFileInfoW(
    ref ushort szDatabaseName,   // WORD*
    IntPtr pvResult,   // void* out
    uint cbMax,   // DWORD
    uint InfoLevel   // DWORD
);

<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetGetDatabaseFileInfoW(
    ByRef szDatabaseName As UShort,   ' WORD*
    pvResult As IntPtr,   ' void* out
    cbMax As UInteger,   ' DWORD
    InfoLevel As UInteger   ' DWORD
) As Integer
End Function

' szDatabaseName : WORD*
' pvResult : void* out
' cbMax : DWORD
' InfoLevel : DWORD
Declare PtrSafe Function JetGetDatabaseFileInfoW Lib "esent" ( _
    ByRef szDatabaseName As Integer, _
    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

JetGetDatabaseFileInfoW = ctypes.windll.esent.JetGetDatabaseFileInfoW
JetGetDatabaseFileInfoW.restype = ctypes.c_int
JetGetDatabaseFileInfoW.argtypes = [
    ctypes.POINTER(ctypes.c_ushort),  # szDatabaseName : WORD*
    ctypes.POINTER(None),  # pvResult : void* out
    wintypes.DWORD,  # cbMax : DWORD
    wintypes.DWORD,  # InfoLevel : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetGetDatabaseFileInfoW = Fiddle::Function.new(
  lib['JetGetDatabaseFileInfoW'],
  [
    Fiddle::TYPE_VOIDP,  # szDatabaseName : WORD*
    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 JetGetDatabaseFileInfoW(
        szDatabaseName: *mut u16,  // WORD*
        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 JetGetDatabaseFileInfoW(ref ushort szDatabaseName, IntPtr pvResult, uint cbMax, uint InfoLevel);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetGetDatabaseFileInfoW' -Namespace Win32 -PassThru
# $api::JetGetDatabaseFileInfoW(szDatabaseName, pvResult, cbMax, InfoLevel)

#uselib "ESENT.dll"
#func global JetGetDatabaseFileInfoW "JetGetDatabaseFileInfoW" wptr, wptr, wptr, wptr
; JetGetDatabaseFileInfoW varptr(szDatabaseName), pvResult, cbMax, InfoLevel   ; 戻り値は stat
; szDatabaseName : WORD* -> "wptr"
; pvResult : void* out -> "wptr"
; cbMax : DWORD -> "wptr"
; InfoLevel : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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