JetAttachDatabase2A

関数

最大サイズを指定してESEデータベースをアタッチする（ANSI版）。

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

シグネチャ

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

INT JetAttachDatabase2A(
    JET_SESID sesid,
    CHAR* szFilename,
    DWORD cpgDatabaseSizeMax,
    DWORD grbit
);

パラメーター

名前	型	方向	説明
sesid	JET_SESID	in	操作に使用するセッションID。
szFilename	CHAR*	in	アタッチする既存データベースファイルのパスを指すANSI文字列。
cpgDatabaseSizeMax	DWORD	in	データベースの最大サイズをページ数で指定する。0で無制限。
grbit	DWORD	in	アタッチ動作を制御するJET_bitDbReadOnly等のフラグ。

戻り値の型: INT

公式ドキュメント

JetAttachDatabase2 関数は、データベースインスタンスで使用するデータベースファイルをアタッチし、そのデータベースの最大サイズを指定します。データベースを使用するには、その後 JetOpenDatabase で開く必要があります。

戻り値

この関数は JET_ERR エラーコードのいずれかを返します。以下は、最もよく返されるものです。(この API のエラーの完全な一覧については、Extensible Storage Engine Error Codes を参照してください。)

戻り値	説明
JET_errSuccess	操作は正常に完了しました。
JET_errBackupInProgress	バックアップ中にデータベースをアタッチすることはできません。
JET_errDatabaseFileReadOnly	szFilename で指定されたデータベースファイルは、書き込み可能である必要があります。読み取り専用属性が設定されていてはならず、実行中のプロセスがそのファイルへ書き込むための十分な特権を持っている必要があります。
JET_errDatabaseInUse	データベースファイルは、別のプロセスによって既に開かれています。
JET_errDatabaseInvalidPath	szFilename に無効なパスが指定されました。szFilename は NULL 以外で、有効なパスを指している必要があります。
JET_errDatabaseSharingViolation	データベースファイルは、別のセッションによって既にアタッチされています。
JET_errFileNotFound	szFilename に指定されたファイルが存在しません。
JET_errPrimaryIndexCorrupted	プライマリインデックスにエラーがあります。これは物理的な破損 (ディスクやメモリの破損など) による場合があります。また、より古いオペレーティングシステムで最後に変更されたデータベースをアタッチし、そのプライマリインデックスが Unicode データを含む列に対して作成されている場合にも返されることがあります。Unicode データに対するインデックスの詳細については、解説を参照してください。
JET_errSecondaryIndexCorrupted	セカンダリインデックスにエラーがあります。これは物理的な破損 (ディスクやメモリの破損など) による場合があります。また、より古いオペレーティングシステムで最後に変更されたデータベースをアタッチし、セカンダリインデックスが Unicode データを含む列に対して作成されている場合にも返されることがあります。Unicode データに対するインデックスの詳細については、解説を参照してください。セカンダリインデックスは、次のコマンドでオフラインユーティリティを使用してデータベースをデフラグすると、完全に再構築されます: esentutl -d。
JET_errTooManyAttachedDatabases	1 つのインスタンスにアタッチできるデータベースの数には上限があります。現在の制限は、インスタンスあたり 7 個のデータベースです。
JET_wrnDatabaseAttached	データベースファイルがこのセッションによって既にアタッチされていることを示す、致命的でない警告です。

解説

データベースファイルをデタッチするには、JetDetachDatabase または JetDetachDatabase2 を使用します。

解説については JetAttachDatabase を参照してください。

要件

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

各言語での呼び出し定義

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

INT JetAttachDatabase2A(
    JET_SESID sesid,
    CHAR* szFilename,
    DWORD cpgDatabaseSizeMax,
    DWORD grbit
);

[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetAttachDatabase2A(
    UIntPtr sesid,   // JET_SESID
    IntPtr szFilename,   // CHAR*
    uint cpgDatabaseSizeMax,   // DWORD
    uint grbit   // DWORD
);

<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetAttachDatabase2A(
    sesid As UIntPtr,   ' JET_SESID
    szFilename As IntPtr,   ' CHAR*
    cpgDatabaseSizeMax As UInteger,   ' DWORD
    grbit As UInteger   ' DWORD
) As Integer
End Function

' sesid : JET_SESID
' szFilename : CHAR*
' cpgDatabaseSizeMax : DWORD
' grbit : DWORD
Declare PtrSafe Function JetAttachDatabase2A Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByVal szFilename As LongPtr, _
    ByVal cpgDatabaseSizeMax As Long, _
    ByVal grbit As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

JetAttachDatabase2A = ctypes.windll.esent.JetAttachDatabase2A
JetAttachDatabase2A.restype = ctypes.c_int
JetAttachDatabase2A.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
    ctypes.POINTER(ctypes.c_byte),  # szFilename : CHAR*
    wintypes.DWORD,  # cpgDatabaseSizeMax : DWORD
    wintypes.DWORD,  # grbit : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetAttachDatabase2A = Fiddle::Function.new(
  lib['JetAttachDatabase2A'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    Fiddle::TYPE_VOIDP,  # szFilename : CHAR*
    -Fiddle::TYPE_INT,  # cpgDatabaseSizeMax : DWORD
    -Fiddle::TYPE_INT,  # grbit : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "esent")]
extern "system" {
    fn JetAttachDatabase2A(
        sesid: usize,  // JET_SESID
        szFilename: *mut i8,  // CHAR*
        cpgDatabaseSizeMax: u32,  // DWORD
        grbit: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Ansi)]
public static extern int JetAttachDatabase2A(UIntPtr sesid, IntPtr szFilename, uint cpgDatabaseSizeMax, uint grbit);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetAttachDatabase2A' -Namespace Win32 -PassThru
# $api::JetAttachDatabase2A(sesid, szFilename, cpgDatabaseSizeMax, grbit)

#uselib "ESENT.dll"
#func global JetAttachDatabase2A "JetAttachDatabase2A" sptr, sptr, sptr, sptr
; JetAttachDatabase2A sesid, varptr(szFilename), cpgDatabaseSizeMax, grbit   ; 戻り値は stat
; sesid : JET_SESID -> "sptr"
; szFilename : CHAR* -> "sptr"
; cpgDatabaseSizeMax : DWORD -> "sptr"
; grbit : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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