ホーム › Storage.Jet › JetGetDatabaseFileInfoA

JetGetDatabaseFileInfoA

関数

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

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

シグネチャ

// ESENT.dll  (ANSI / -A)
#include <windows.h>

INT JetGetDatabaseFileInfoA(
    CHAR* szDatabaseName,
    void* pvResult,
    DWORD cbMax,
    DWORD InfoLevel
);

パラメーター

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

戻り値の型: INT

公式ドキュメント

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

戻り値

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

戻り値コード	説明
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  (ANSI / -A)
#include <windows.h>

INT JetGetDatabaseFileInfoA(
    CHAR* szDatabaseName,
    void* pvResult,
    DWORD cbMax,
    DWORD InfoLevel
);

[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetGetDatabaseFileInfoA(
    IntPtr szDatabaseName,   // CHAR*
    IntPtr pvResult,   // void* out
    uint cbMax,   // DWORD
    uint InfoLevel   // DWORD
);

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

' szDatabaseName : CHAR*
' pvResult : void* out
' cbMax : DWORD
' InfoLevel : DWORD
Declare PtrSafe Function JetGetDatabaseFileInfoA Lib "esent" ( _
    ByVal szDatabaseName As LongPtr, _
    ByVal pvResult As LongPtr, _
    ByVal cbMax 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

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetGetDatabaseFileInfoA = Fiddle::Function.new(
  lib['JetGetDatabaseFileInfoA'],
  [
    Fiddle::TYPE_VOIDP,  # szDatabaseName : CHAR*
    Fiddle::TYPE_VOIDP,  # pvResult : void* out
    -Fiddle::TYPE_INT,  # cbMax : DWORD
    -Fiddle::TYPE_INT,  # InfoLevel : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "esent")]
extern "system" {
    fn JetGetDatabaseFileInfoA(
        szDatabaseName: *mut i8,  // CHAR*
        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.Ansi)]
public static extern int JetGetDatabaseFileInfoA(IntPtr szDatabaseName, IntPtr pvResult, uint cbMax, uint InfoLevel);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetGetDatabaseFileInfoA' -Namespace Win32 -PassThru
# $api::JetGetDatabaseFileInfoA(szDatabaseName, pvResult, cbMax, InfoLevel)

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

出力引数:

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