Win32 API 日本語リファレンス
ホーム › Storage.Jet › JetRestore2A

JetRestore2A

関数
復元先を指定してバックアップから復元する(ANSI版)。
DLLESENT.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

INT JetRestore2A(
    CHAR* sz,
    CHAR* szDest,   // optional
    JET_PFNSTATUS pfn   // optional
);

パラメーター

名前型方向説明
szCHAR*in復元元バックアップが格納されたディレクトリのパスを指す終端付きANSI文字列ポインタ。
szDestCHAR*inoptional復元先ディレクトリのパスを指す終端付きANSI文字列ポインタ。NULLで元の場所に復元する。
pfnJET_PFNSTATUSinoptional進捗通知を受け取るステータスコールバック関数(JET_PFNSTATUS)。NULL可。

戻り値の型: INT

公式ドキュメント

JetRestore2 は、アタッチされているすべてのデータベースを含む、インスタンスのストリーミング バックアップを復元および回復します。この関数は主に、データベースのインスタンスを 1 つしか使用できない Windows 2000 以前のデータベース エンジンとの下位互換性のために用意されています。この場合、復元されるのは アクティブなインスタンスです。

戻り値

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

リターン コード

説明

JET_errSuccess

操作は正常に完了しました。

JET_errAlreadyInitialized

このインスタンスに対してエンジンが既に初期化されているため、操作は失敗しました。

JET_errInvalidLogSequence

バックアップ セット内のログ ファイルと、現在のログ パスにあるログ ファイルが一致しません。

JET_errInvalidParameter

指定されたパラメーターのいずれかに予期しない値が含まれているか、別のパラメーターの値と組み合わせたときに意味をなさない値が含まれていました。Windows XP 以降のリリースでは、エンジンがマルチインスタンス モードであり、pinstance が無効なインスタンスを参照している場合に、JetRestoreInstance がこのエラーを返します。

JET_errInvalidPath

指定されたパスの一部 (バックアップ パス、復元先パス、インスタンスのログ パスまたはシステム パス) が無効であるため、操作は失敗しました。

JET_errPageSizeMismatch

エンジンに構成されているデータベース ページ サイズ (JetSetSystemParameter で JET_paramDatabasePageSize に設定したもの) が、トランザクション ログ ファイル、またはそのトランザクション ログ ファイルに関連付けられたデータベースの作成に使用されたデータベース ページ サイズと一致しないため、操作は失敗しました。

JET_errRunningInMultiInstanceMode

パラメーターがシングル インスタンス モード (Windows 2000 互換モード) を示しているにもかかわらず、エンジンが既にマルチインスタンス モードであるため、操作は失敗しました。

成功した場合、バックアップ セット内のデータベース ファイルが元の場所に復元され、データベースがトランザクション的に整合性のあるクリーンな状態になるように回復処理が実行されます。回復処理では、バックアップ セット内のログ ファイルと、ログ パスにログ ファイルが存在する場合はそのログ ファイルが再生されます。この回復処理により、チェックポイント ファイル、トランザクション ログ ファイル、およびそれらのトランザクション ログ ファイルが参照するすべてのデータベースが変更されます。

失敗した場合、インスタンスは未初期化の状態のままとなります。ただし、復元の開始とデータベースの回復を試みる過程で、トランザクション ログ ファイルおよびそれらが参照するデータベースの状態が変更されている可能性が高い点に注意してください。

解説

回復処理では、バックアップ時にインスタンスにアタッチされていたデータベースが再構築され、変更内容がデータベース ファイルに書き戻されます。その結果、データベースはトランザクション的に整合性のある状態になります。可能であれば、バックアップ取得時点以降にトランザクション ログ内で見つかった最新の変更までの内容もデータベースに保存されます。これは、バックアップ取得以降に生成されたトランザクション ログがトランザクション ログ ディレクトリにまだ残っている場合に可能です。インスタンスで循環ログが有効になっている場合、生成されたトランザクション ログは再利用されるため、回復処理ではバックアップ時点までの変更を保存できる点に注意してください。いずれの場合も、データベースに対して再生するトランザクション ログ ファイルの数が多いと、この処理にはかなりの時間がかかることがあります。

JetRestore 系の関数は、対象のインスタンスに対して JetInit を呼び出す前に呼び出す必要があります。

回復処理中は多数のデータベース ページとトランザクション ログが使用されるため、これらの関数からはさまざまなエラーが返される可能性があります。そうしたエラーには、Jet_errOutOfMemory のような一時的なリソース割り当ての失敗を表すものから、JET_errReadVerifyFailure、JET_errLogFileCorrupt、JET_errBadPageLink のような物理的な破損を表すものまであります。これらのエラーはほとんどの場合ハードウェアの問題によって発生するため、回避することはできません。ファイルの管理ミスは、多くの場合 JET_errMissingLogFile、JET_errAttachedDatabaseMismatch、JET_errDatabaseSharingViolation、JET_errInvalidLogSequence として現れます。これらのエラーはアプリケーション側で防止できます。アプリケーションは、これらのファイルの格納場所が、ユーザーや他のアプリケーションなどの外部要因によって操作されないよう、注意して保護する必要があります。インスタンスを完全に破棄したい場合は、そのインスタンスに関連付けられたすべてのファイルを削除する必要があります。これには、チェックポイント ファイル、トランザクション ログ ファイル、およびインスタンスにアタッチされているすべてのデータベース ファイルが含まれます。

回復処理の各段階では、トランザクション ログの再生の進行状況や復元の最終結果を含むイベント ログ エントリが生成されます。

要件

要件 値

クライアント

Windows Vista、Windows XP、または Windows 2000 Professional が必要です。

サーバー

Windows Server 2008、Windows Server 2003、または Windows 2000 Server が必要です。

ヘッダー

Esent.h で宣言されています。

ライブラリ

ESENT.lib を使用します。

DLL

ESENT.dll が必要です。

Unicode

JetRestore2W (Unicode) および JetRestore2A (ANSI) として実装されています。

関連項目

JET_ERR
JET_GRBIT
JET_INSTANCE
JetBackup
JetBackupInstance
JetCreateInstance
JetInit
JetRestore
JetRestoreInstance
JetSetSystemParameter

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)

各言語での呼び出し定義

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

INT JetRestore2A(
    CHAR* sz,
    CHAR* szDest,   // optional
    JET_PFNSTATUS pfn   // optional
);
[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetRestore2A(
    IntPtr sz,   // CHAR*
    IntPtr szDest,   // CHAR* optional
    IntPtr pfn   // JET_PFNSTATUS optional
);
<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetRestore2A(
    sz As IntPtr,   ' CHAR*
    szDest As IntPtr,   ' CHAR* optional
    pfn As IntPtr   ' JET_PFNSTATUS optional
) As Integer
End Function
' sz : CHAR*
' szDest : CHAR* optional
' pfn : JET_PFNSTATUS optional
Declare PtrSafe Function JetRestore2A Lib "esent" ( _
    ByVal sz As LongPtr, _
    ByVal szDest As LongPtr, _
    ByVal pfn As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

JetRestore2A = ctypes.windll.esent.JetRestore2A
JetRestore2A.restype = ctypes.c_int
JetRestore2A.argtypes = [
    ctypes.POINTER(ctypes.c_byte),  # sz : CHAR*
    ctypes.POINTER(ctypes.c_byte),  # szDest : CHAR* optional
    ctypes.c_void_p,  # pfn : JET_PFNSTATUS optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetRestore2A = Fiddle::Function.new(
  lib['JetRestore2A'],
  [
    Fiddle::TYPE_VOIDP,  # sz : CHAR*
    Fiddle::TYPE_VOIDP,  # szDest : CHAR* optional
    Fiddle::TYPE_VOIDP,  # pfn : JET_PFNSTATUS optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "esent")]
extern "system" {
    fn JetRestore2A(
        sz: *mut i8,  // CHAR*
        szDest: *mut i8,  // CHAR* optional
        pfn: *const core::ffi::c_void  // JET_PFNSTATUS optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Ansi)]
public static extern int JetRestore2A(IntPtr sz, IntPtr szDest, IntPtr pfn);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetRestore2A' -Namespace Win32 -PassThru
# $api::JetRestore2A(sz, szDest, pfn)
#uselib "ESENT.dll"
#func global JetRestore2A "JetRestore2A" sptr, sptr, sptr
; JetRestore2A varptr(sz), varptr(szDest), pfn   ; 戻り値は stat
; sz : CHAR* -> "sptr"
; szDest : CHAR* optional -> "sptr"
; pfn : JET_PFNSTATUS optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ESENT.dll"
#cfunc global JetRestore2A "JetRestore2A" var, var, sptr
; res = JetRestore2A(sz, szDest, pfn)
; sz : CHAR* -> "var"
; szDest : CHAR* optional -> "var"
; pfn : JET_PFNSTATUS optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT JetRestore2A(CHAR* sz, CHAR* szDest, JET_PFNSTATUS pfn)
#uselib "ESENT.dll"
#cfunc global JetRestore2A "JetRestore2A" var, var, intptr
; res = JetRestore2A(sz, szDest, pfn)
; sz : CHAR* -> "var"
; szDest : CHAR* optional -> "var"
; pfn : JET_PFNSTATUS optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetRestore2A = esent.NewProc("JetRestore2A")
)

// sz (CHAR*), szDest (CHAR* optional), pfn (JET_PFNSTATUS optional)
r1, _, err := procJetRestore2A.Call(
	uintptr(sz),
	uintptr(szDest),
	uintptr(pfn),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function JetRestore2A(
  sz: Pointer;   // CHAR*
  szDest: Pointer;   // CHAR* optional
  pfn: Pointer   // JET_PFNSTATUS optional
): Integer; stdcall;
  external 'ESENT.dll' name 'JetRestore2A';
result := DllCall("ESENT\JetRestore2A"
    , "Ptr", sz   ; CHAR*
    , "Ptr", szDest   ; CHAR* optional
    , "Ptr", pfn   ; JET_PFNSTATUS optional
    , "Int")   ; return: INT
●JetRestore2A(sz, szDest, pfn) = DLL("ESENT.dll", "int JetRestore2A(void*, void*, void*)")
# 呼び出し: JetRestore2A(sz, szDest, pfn)
# sz : CHAR* -> "void*"
# szDest : CHAR* optional -> "void*"
# pfn : JET_PFNSTATUS optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "esent" fn JetRestore2A(
    sz: [*c]i8, // CHAR*
    szDest: [*c]i8, // CHAR* optional
    pfn: ?*anyopaque // JET_PFNSTATUS optional
) callconv(std.os.windows.WINAPI) i32;
proc JetRestore2A(
    sz: ptr int8,  # CHAR*
    szDest: ptr int8,  # CHAR* optional
    pfn: pointer  # JET_PFNSTATUS optional
): int32 {.importc: "JetRestore2A", stdcall, dynlib: "ESENT.dll".}
pragma(lib, "esent");
extern(Windows)
int JetRestore2A(
    byte* sz,   // CHAR*
    byte* szDest,   // CHAR* optional
    void* pfn   // JET_PFNSTATUS optional
);
ccall((:JetRestore2A, "ESENT.dll"), stdcall, Int32,
      (Ptr{Int8}, Ptr{Int8}, Ptr{Cvoid}),
      sz, szDest, pfn)
# sz : CHAR* -> Ptr{Int8}
# szDest : CHAR* optional -> Ptr{Int8}
# pfn : JET_PFNSTATUS optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetRestore2A(
    int8_t* sz,
    int8_t* szDest,
    void* pfn);
]]
local esent = ffi.load("esent")
-- esent.JetRestore2A(sz, szDest, pfn)
-- sz : CHAR*
-- szDest : CHAR* optional
-- pfn : JET_PFNSTATUS optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetRestore2A = lib.func('__stdcall', 'JetRestore2A', 'int32_t', ['int8_t *', 'int8_t *', 'void *']);
// JetRestore2A(sz, szDest, pfn)
// sz : CHAR* -> 'int8_t *'
// szDest : CHAR* optional -> 'int8_t *'
// pfn : JET_PFNSTATUS optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("ESENT.dll", {
  JetRestore2A: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.JetRestore2A(sz, szDest, pfn)
// sz : CHAR* -> "pointer"
// szDest : CHAR* optional -> "pointer"
// pfn : JET_PFNSTATUS optional -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetRestore2A(
    int8_t* sz,
    int8_t* szDest,
    void* pfn);
C, "ESENT.dll");
// $ffi->JetRestore2A(sz, szDest, pfn);
// sz : CHAR*
// szDest : CHAR* optional
// pfn : JET_PFNSTATUS optional
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Esent extends StdCallLibrary {
    Esent INSTANCE = Native.load("esent", Esent.class, W32APIOptions.ASCII_OPTIONS);
    int JetRestore2A(
        byte[] sz,   // CHAR*
        byte[] szDest,   // CHAR* optional
        Callback pfn   // JET_PFNSTATUS optional
    );
}
@[Link("esent")]
lib LibESENT
  fun JetRestore2A = JetRestore2A(
    sz : Int8*,   # CHAR*
    szDest : Int8*,   # CHAR* optional
    pfn : Void*   # JET_PFNSTATUS optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef JetRestore2ANative = Int32 Function(Pointer<Int8>, Pointer<Int8>, Pointer<Void>);
typedef JetRestore2ADart = int Function(Pointer<Int8>, Pointer<Int8>, Pointer<Void>);
final JetRestore2A = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetRestore2ANative, JetRestore2ADart>('JetRestore2A');
// sz : CHAR* -> Pointer<Int8>
// szDest : CHAR* optional -> Pointer<Int8>
// pfn : JET_PFNSTATUS optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetRestore2A(
  sz: Pointer;   // CHAR*
  szDest: Pointer;   // CHAR* optional
  pfn: Pointer   // JET_PFNSTATUS optional
): Integer; stdcall;
  external 'ESENT.dll' name 'JetRestore2A';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetRestore2A"
  c_JetRestore2A :: Ptr Int8 -> Ptr Int8 -> Ptr () -> IO Int32
-- sz : CHAR* -> Ptr Int8
-- szDest : CHAR* optional -> Ptr Int8
-- pfn : JET_PFNSTATUS optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetrestore2a =
  foreign "JetRestore2A"
    ((ptr int8_t) @-> (ptr int8_t) @-> (ptr void) @-> returning int32_t)
(* sz : CHAR* -> (ptr int8_t) *)
(* szDest : CHAR* optional -> (ptr int8_t) *)
(* pfn : JET_PFNSTATUS optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library esent (t "ESENT.dll"))
(cffi:use-foreign-library esent)

(cffi:defcfun ("JetRestore2A" jet-restore2-a :convention :stdcall) :int32
  (sz :pointer)   ; CHAR*
  (sz-dest :pointer)   ; CHAR* optional
  (pfn :pointer))   ; JET_PFNSTATUS optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetRestore2A = Win32::API::More->new('ESENT',
    'int JetRestore2A(LPVOID sz, LPVOID szDest, LPVOID pfn)');
# my $ret = $JetRestore2A->Call($sz, $szDest, $pfn);
# sz : CHAR* -> LPVOID
# szDest : CHAR* optional -> LPVOID
# pfn : JET_PFNSTATUS optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

文字セット違い
類似 API
使用する型