JetAttachDatabase2W

関数

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

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

シグネチャ

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

INT JetAttachDatabase2W(
    JET_SESID sesid,
    WORD* szFilename,
    DWORD cpgDatabaseSizeMax,
    DWORD grbit
);

パラメーター

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

戻り値の型: INT

公式ドキュメント

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

戻り値

この関数は JET_ERR エラーコードのいずれかを返します。よく返されるものを次に示します。 (この API が返すエラーの完全な一覧については、拡張可能記憶域エンジンのエラーコードを参照してください。)

戻り値	説明
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  (Unicode / -W)
#include <windows.h>

INT JetAttachDatabase2W(
    JET_SESID sesid,
    WORD* szFilename,
    DWORD cpgDatabaseSizeMax,
    DWORD grbit
);

[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetAttachDatabase2W(
    UIntPtr sesid,   // JET_SESID
    ref ushort szFilename,   // WORD*
    uint cpgDatabaseSizeMax,   // DWORD
    uint grbit   // DWORD
);

<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetAttachDatabase2W(
    sesid As UIntPtr,   ' JET_SESID
    ByRef szFilename As UShort,   ' WORD*
    cpgDatabaseSizeMax As UInteger,   ' DWORD
    grbit As UInteger   ' DWORD
) As Integer
End Function

' sesid : JET_SESID
' szFilename : WORD*
' cpgDatabaseSizeMax : DWORD
' grbit : DWORD
Declare PtrSafe Function JetAttachDatabase2W Lib "esent" ( _
    ByVal sesid As LongPtr, _
    ByRef szFilename As Integer, _
    ByVal cpgDatabaseSizeMax As Long, _
    ByVal grbit 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

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetAttachDatabase2W = Fiddle::Function.new(
  lib['JetAttachDatabase2W'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
    Fiddle::TYPE_VOIDP,  # szFilename : WORD*
    -Fiddle::TYPE_INT,  # cpgDatabaseSizeMax : DWORD
    -Fiddle::TYPE_INT,  # grbit : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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