JetCreateDatabase2W

関数

最大サイズを指定してESEデータベースを作成する。

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

シグネチャ

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

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

パラメーター

名前	型	方向	説明
sesid	JET_SESID	in	操作に使用するセッションID。
szFilename	WORD*	in	作成するデータベースファイルのパスを指すワイド文字列(WORD*)。
cpgDatabaseSizeMax	DWORD	in	データベースの最大サイズをページ数で指定する。0で無制限。
pdbid	DWORD*	out	生成されたデータベースID(dbid)を受け取るDWORDポインタ。
grbit	DWORD	in	作成動作を制御するJET_bitDbCreate系フラグ。

戻り値の型: INT

公式ドキュメント

JetCreateDatabase2 関数は、データベースの最大サイズを指定して、ESE データベースエンジンで使用するデータベースファイルを作成し、アタッチします。cpgDatabaseSizeMax に 0 を指定して JetCreateDatabase2 を呼び出すことは、szConnect に NULL を指定して JetCreateDatabase を呼び出すことと同じです。現在、1 インスタンスにつき最大 7 個のデータベースを作成できます。

戻り値

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

戻り値コード	説明
JET_errSuccess	操作は正常に完了しました。
JET_errDatabaseDuplicate	szFilename で指定された名前のデータベースが既に存在します。このエラーが返された場合、データベースはアタッチされません。
JET_errDatabaseInUse	排他アクセスが要求されたものの許可されなかった場合、または別のセッションが既にデータベースを排他的に開いている場合に返されることがあります。
JET_errDatabaseInvalidPages	cpgDatabaseSizeMax がデータベースで許可される最大ページ数を超えている場合に返されます。現在の最大値は 2147483646 (0x7ffffffe) です。
JET_errDatabaseInvalidPath	szFilename に無効なパスが指定されました。szFilename は NULL 以外である必要があります。既定では、szFilename は既存のディレクトリを指している必要があります。JET_paramCreatePathIfNotExist が設定されている場合は、パスが作成されます (JetSetSystemParameter を参照してください)。
JET_errDatabaseLocked	別のセッションが既に (JET_bitDbExclusive を使用して) データベースを排他的に開いていることを示します。
JET_errDatabaseNotFound	データベースが事前にアタッチされていません (JetAttachDatabase を参照してください)。
JET_errDatabaseSharingViolation	データベースファイルは、別のセッションによって既にアタッチされています。
JET_errInTransaction	トランザクション中にデータベースを作成しようとしました。
JET_errInvalidDatabase	有効なデータベースファイルではないファイルを開こうとしました。
JET_errOneDatabasePerSession	JET_paramOneDatabasePerSession が設定されている状態で、複数のデータベースを開こうとしました。System Parameters を参照してください。
JET_errOutOfMemory	システムのリソースが不足しました。
JET_errTooManyAttachedDatabases	1 インスタンスにつきアタッチできるデータベースの数には上限があります。現在の上限は 1 インスタンスにつき 7 個です。
JET_wrnDatabaseAttached	データベースファイルがこのセッションによって既にアタッチされていることを示す、致命的でない警告です。
JET_wrnFileOpenReadOnly	JET_wrnFileOpenReadOnly は、ファイルが読み取り専用でアタッチされたものの、JetCreateDatabase が JET_bitDbReadOnly を渡さなかったことを示します。データベースは引き続き読み取り専用アクセスで開かれます。

解説

szFilename で指定したデータベースが既に存在し、JET_bitDbOverwriteExisting が渡されなかった場合、この API 呼び出しは失敗します。JET_bitDbOverwriteExisting が渡された場合は、古いデータベースファイルが先に削除されます。

API がデータベースファイルを作成した後で別のエラーが発生した場合、API はクリーンアップを行い、そのファイルを削除します。

JetCreateDatabase2 は暗黙的にデータベースを開きます。その後に JetOpenDatabase を呼び出す必要はありません。

要件

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

各言語での呼び出し定義

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

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

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

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

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

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "esent")]
extern "system" {
    fn JetCreateDatabase2W(
        sesid: usize,  // JET_SESID
        szFilename: *mut u16,  // WORD*
        cpgDatabaseSizeMax: u32,  // DWORD
        pdbid: *mut u32,  // DWORD* out
        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 JetCreateDatabase2W(UIntPtr sesid, ref ushort szFilename, uint cpgDatabaseSizeMax, out uint pdbid, uint grbit);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetCreateDatabase2W' -Namespace Win32 -PassThru
# $api::JetCreateDatabase2W(sesid, szFilename, cpgDatabaseSizeMax, pdbid, grbit)

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

出力引数:

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