JetInit3W

関数

復元情報を指定してESEインスタンスを初期化する。

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

シグネチャ

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

INT JetInit3W(
    JET_INSTANCE* pinstance,   // optional
    JET_RSTINFO_W* prstInfo,   // optional
    DWORD grbit
);

パラメーター

名前	型	方向	説明
pinstance	JET_INSTANCE*	inoutoptional	初期化するインスタンスハンドルへのポインタ。NULLまたはNilで既定インスタンスを生成する。
prstInfo	JET_RSTINFO_W*	inoptional	リカバリ進捗状況や追加データベース指定を行うJET_RSTINFO_W構造体へのポインタ。NULL可。
grbit	DWORD	in	初期化動作を制御するJET_bitInitオプションのビットフラグ。

戻り値の型: INT

公式ドキュメント

JetInit3 関数は、データベースエンジンを、アプリケーションがデータベースファイルを使用できる状態にします。エンジンは初期化に向けてあらかじめ適切に構成されている必要があり、その構成は JetSetSystemParameter 関数を使用して行います。なお、データベースのクラッシュ回復は初期化処理の一部として自動的に実行されます。

戻り値

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

解説

インスタンスは、JetSetSystemParameter 関数以外から使用する前に、JetInit3 関数の呼び出しによって初期化する必要があります。

インスタンスは JetTerm 関数の呼び出しによって破棄されます。これは、そのインスタンスが JetInit 関数によって初期化されていない場合でも同様です。インスタンスは、データベースエンジンにおける回復可能性の単位です。インスタンスは、一連のデータベースファイル内のデータの整合性を保護するために使用されるすべてのファイルのライフサイクルを制御します。これらのファイルには、チェックポイントファイルとトランザクションログファイルが含まれます。なお、JetInit3 関数が失敗した場合は JetTerm を呼び出さないでください。ただし、JetInit3 が一度も呼び出されなかった場合や JetInit3 が成功した場合は、JetCreateInstance2 によって作成されたすべてのインスタンスに対して JetTerm を呼び出す必要があります。

関連するデータベースがすべて存在しないログのセットに対して回復が実行されており(通常の状況ではエラー JET_errAttachedDatabaseMismatch が返されます)、データベースが欠落していても回復を続行したい場合は、JET_bitReplayIgnoreMissingDB を使用して、利用可能なデータベースについて回復を続行します。

クラッシュ回復は必ずしもクラッシュ時と同じコンピューター上で(かつ同じ構成で)実行されるとは限りませんが、データベースの場所は通常変わりません。ただし、ファイルを別のコンピューターに移動する場合や、スナップショットバックアップを別の場所に復元する場合など、一部のシナリオではこれが当てはまりません。JetInit3 関数では、(JET_RSTINFO 構造体および JET_RSTMAP 構造体を使用して)以前のデータベースの場所と新しい場所との間のマッピングを指定できます。実際には、データベースファイルが新しい場所に存在していれば、必要なのは新しい場所だけです。復元されたデータベースの場所が判明すれば、復元処理を通じてデータベースを識別するためにデータベースシグネチャが使用されます。元のデータベースの場所が必要になるのは、データベースを再作成する必要がある場合だけであり、その場合はシグネチャが判明しています。

さらに、Undo 操作の後に回復を停止する必要がある場合は、回復を停止する特定のログ位置を指定できます。なお、これには、指定した位置がそのログ世代に含まれるものの実際のログの末尾を超えている場合に、特定のログ世代の末尾で停止する機能も含まれます。

詳細については、JetInit のトピックの「解説」セクションを参照してください。

要件

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

各言語での呼び出し定義

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

INT JetInit3W(
    JET_INSTANCE* pinstance,   // optional
    JET_RSTINFO_W* prstInfo,   // optional
    DWORD grbit
);

[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetInit3W(
    IntPtr pinstance,   // JET_INSTANCE* optional, in/out
    IntPtr prstInfo,   // JET_RSTINFO_W* optional
    uint grbit   // DWORD
);

<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetInit3W(
    pinstance As IntPtr,   ' JET_INSTANCE* optional, in/out
    prstInfo As IntPtr,   ' JET_RSTINFO_W* optional
    grbit As UInteger   ' DWORD
) As Integer
End Function

' pinstance : JET_INSTANCE* optional, in/out
' prstInfo : JET_RSTINFO_W* optional
' grbit : DWORD
Declare PtrSafe Function JetInit3W Lib "esent" ( _
    ByVal pinstance As LongPtr, _
    ByVal prstInfo As LongPtr, _
    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

JetInit3W = ctypes.windll.esent.JetInit3W
JetInit3W.restype = ctypes.c_int
JetInit3W.argtypes = [
    ctypes.c_void_p,  # pinstance : JET_INSTANCE* optional, in/out
    ctypes.c_void_p,  # prstInfo : JET_RSTINFO_W* optional
    wintypes.DWORD,  # grbit : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetInit3W = Fiddle::Function.new(
  lib['JetInit3W'],
  [
    Fiddle::TYPE_VOIDP,  # pinstance : JET_INSTANCE* optional, in/out
    Fiddle::TYPE_VOIDP,  # prstInfo : JET_RSTINFO_W* optional
    -Fiddle::TYPE_INT,  # grbit : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "esent")]
extern "system" {
    fn JetInit3W(
        pinstance: *mut usize,  // JET_INSTANCE* optional, in/out
        prstInfo: *mut JET_RSTINFO_W,  // JET_RSTINFO_W* optional
        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 JetInit3W(IntPtr pinstance, IntPtr prstInfo, uint grbit);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetInit3W' -Namespace Win32 -PassThru
# $api::JetInit3W(pinstance, prstInfo, grbit)

#uselib "ESENT.dll"
#func global JetInit3W "JetInit3W" wptr, wptr, wptr
; JetInit3W varptr(pinstance), varptr(prstInfo), grbit   ; 戻り値は stat
; pinstance : JET_INSTANCE* optional, in/out -> "wptr"
; prstInfo : JET_RSTINFO_W* optional -> "wptr"
; grbit : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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