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

JetRestoreInstanceA

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

シグネチャ

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

INT JetRestoreInstanceA(
    JET_INSTANCE instance,
    CHAR* sz,
    CHAR* szDest,   // optional
    JET_PFNSTATUS pfn   // optional
);

パラメーター

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

戻り値の型: INT

公式ドキュメント

JetRestoreInstance 関数は、アタッチされているすべてのデータベースを含む、インスタンスのストリーミングバックアップを復元して回復します。JetBackupInstance 関数で作成されたバックアップと連携するように設計されています。これは、最も単純で最もカプセル化された復元関数です。

戻り値

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

リターンコード

説明

JET_errSuccess

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

JET_errAlreadyInitialized

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

JET_errInvalidLogSequence

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

JET_errInvalidParameter

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

JET_errInvalidPath

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

JET_errPageSizeMismatch

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

JET_errRunningInMultiInstanceMode

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

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

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

Remarks

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

JetRestoreInstance は、JetCreateInstance で既に作成されているインスタンスに対して呼び出す必要があります。

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

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

Requirements

Requirement Value

Client

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

Server

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

Header

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

Library

ESENT.lib を使用します。

DLL

ESENT.dll が必要です。

Unicode

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

See Also

JET_ERR JET_GRBIT JET_INSTANCE JetBackup JetBackupInstance JetCreateInstance 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 JetRestoreInstanceA(
    JET_INSTANCE instance,
    CHAR* sz,
    CHAR* szDest,   // optional
    JET_PFNSTATUS pfn   // optional
);
[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetRestoreInstanceA(
    UIntPtr instance,   // JET_INSTANCE
    IntPtr sz,   // CHAR*
    IntPtr szDest,   // CHAR* optional
    IntPtr pfn   // JET_PFNSTATUS optional
);
<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetRestoreInstanceA(
    instance As UIntPtr,   ' JET_INSTANCE
    sz As IntPtr,   ' CHAR*
    szDest As IntPtr,   ' CHAR* optional
    pfn As IntPtr   ' JET_PFNSTATUS optional
) As Integer
End Function
' instance : JET_INSTANCE
' sz : CHAR*
' szDest : CHAR* optional
' pfn : JET_PFNSTATUS optional
Declare PtrSafe Function JetRestoreInstanceA Lib "esent" ( _
    ByVal instance As LongPtr, _
    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

JetRestoreInstanceA = ctypes.windll.esent.JetRestoreInstanceA
JetRestoreInstanceA.restype = ctypes.c_int
JetRestoreInstanceA.argtypes = [
    ctypes.c_size_t,  # instance : JET_INSTANCE
    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')
JetRestoreInstanceA = Fiddle::Function.new(
  lib['JetRestoreInstanceA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # instance : JET_INSTANCE
    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 JetRestoreInstanceA(
        instance: usize,  // JET_INSTANCE
        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 JetRestoreInstanceA(UIntPtr instance, IntPtr sz, IntPtr szDest, IntPtr pfn);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetRestoreInstanceA' -Namespace Win32 -PassThru
# $api::JetRestoreInstanceA(instance, sz, szDest, pfn)
#uselib "ESENT.dll"
#func global JetRestoreInstanceA "JetRestoreInstanceA" sptr, sptr, sptr, sptr
; JetRestoreInstanceA instance, varptr(sz), varptr(szDest), pfn   ; 戻り値は stat
; instance : JET_INSTANCE -> "sptr"
; sz : CHAR* -> "sptr"
; szDest : CHAR* optional -> "sptr"
; pfn : JET_PFNSTATUS optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ESENT.dll"
#cfunc global JetRestoreInstanceA "JetRestoreInstanceA" sptr, var, var, sptr
; res = JetRestoreInstanceA(instance, sz, szDest, pfn)
; instance : JET_INSTANCE -> "sptr"
; sz : CHAR* -> "var"
; szDest : CHAR* optional -> "var"
; pfn : JET_PFNSTATUS optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT JetRestoreInstanceA(JET_INSTANCE instance, CHAR* sz, CHAR* szDest, JET_PFNSTATUS pfn)
#uselib "ESENT.dll"
#cfunc global JetRestoreInstanceA "JetRestoreInstanceA" intptr, var, var, intptr
; res = JetRestoreInstanceA(instance, sz, szDest, pfn)
; instance : JET_INSTANCE -> "intptr"
; 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")
	procJetRestoreInstanceA = esent.NewProc("JetRestoreInstanceA")
)

// instance (JET_INSTANCE), sz (CHAR*), szDest (CHAR* optional), pfn (JET_PFNSTATUS optional)
r1, _, err := procJetRestoreInstanceA.Call(
	uintptr(instance),
	uintptr(sz),
	uintptr(szDest),
	uintptr(pfn),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function JetRestoreInstanceA(
  instance: NativeUInt;   // JET_INSTANCE
  sz: Pointer;   // CHAR*
  szDest: Pointer;   // CHAR* optional
  pfn: Pointer   // JET_PFNSTATUS optional
): Integer; stdcall;
  external 'ESENT.dll' name 'JetRestoreInstanceA';
result := DllCall("ESENT\JetRestoreInstanceA"
    , "UPtr", instance   ; JET_INSTANCE
    , "Ptr", sz   ; CHAR*
    , "Ptr", szDest   ; CHAR* optional
    , "Ptr", pfn   ; JET_PFNSTATUS optional
    , "Int")   ; return: INT
●JetRestoreInstanceA(instance, sz, szDest, pfn) = DLL("ESENT.dll", "int JetRestoreInstanceA(int, void*, void*, void*)")
# 呼び出し: JetRestoreInstanceA(instance, sz, szDest, pfn)
# instance : JET_INSTANCE -> "int"
# 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 JetRestoreInstanceA(
    instance: usize, // JET_INSTANCE
    sz: [*c]i8, // CHAR*
    szDest: [*c]i8, // CHAR* optional
    pfn: ?*anyopaque // JET_PFNSTATUS optional
) callconv(std.os.windows.WINAPI) i32;
proc JetRestoreInstanceA(
    instance: uint,  # JET_INSTANCE
    sz: ptr int8,  # CHAR*
    szDest: ptr int8,  # CHAR* optional
    pfn: pointer  # JET_PFNSTATUS optional
): int32 {.importc: "JetRestoreInstanceA", stdcall, dynlib: "ESENT.dll".}
pragma(lib, "esent");
extern(Windows)
int JetRestoreInstanceA(
    size_t instance,   // JET_INSTANCE
    byte* sz,   // CHAR*
    byte* szDest,   // CHAR* optional
    void* pfn   // JET_PFNSTATUS optional
);
ccall((:JetRestoreInstanceA, "ESENT.dll"), stdcall, Int32,
      (Csize_t, Ptr{Int8}, Ptr{Int8}, Ptr{Cvoid}),
      instance, sz, szDest, pfn)
# instance : JET_INSTANCE -> Csize_t
# 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 JetRestoreInstanceA(
    uintptr_t instance,
    int8_t* sz,
    int8_t* szDest,
    void* pfn);
]]
local esent = ffi.load("esent")
-- esent.JetRestoreInstanceA(instance, sz, szDest, pfn)
-- instance : JET_INSTANCE
-- 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 JetRestoreInstanceA = lib.func('__stdcall', 'JetRestoreInstanceA', 'int32_t', ['uintptr_t', 'int8_t *', 'int8_t *', 'void *']);
// JetRestoreInstanceA(instance, sz, szDest, pfn)
// instance : JET_INSTANCE -> 'uintptr_t'
// 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", {
  JetRestoreInstanceA: { parameters: ["usize", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.JetRestoreInstanceA(instance, sz, szDest, pfn)
// instance : JET_INSTANCE -> "usize"
// 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 JetRestoreInstanceA(
    size_t instance,
    int8_t* sz,
    int8_t* szDest,
    void* pfn);
C, "ESENT.dll");
// $ffi->JetRestoreInstanceA(instance, sz, szDest, pfn);
// instance : JET_INSTANCE
// 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 JetRestoreInstanceA(
        long instance,   // JET_INSTANCE
        byte[] sz,   // CHAR*
        byte[] szDest,   // CHAR* optional
        Callback pfn   // JET_PFNSTATUS optional
    );
}
@[Link("esent")]
lib LibESENT
  fun JetRestoreInstanceA = JetRestoreInstanceA(
    instance : LibC::SizeT,   # JET_INSTANCE
    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 JetRestoreInstanceANative = Int32 Function(UintPtr, Pointer<Int8>, Pointer<Int8>, Pointer<Void>);
typedef JetRestoreInstanceADart = int Function(int, Pointer<Int8>, Pointer<Int8>, Pointer<Void>);
final JetRestoreInstanceA = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetRestoreInstanceANative, JetRestoreInstanceADart>('JetRestoreInstanceA');
// instance : JET_INSTANCE -> UintPtr
// sz : CHAR* -> Pointer<Int8>
// szDest : CHAR* optional -> Pointer<Int8>
// pfn : JET_PFNSTATUS optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetRestoreInstanceA(
  instance: NativeUInt;   // JET_INSTANCE
  sz: Pointer;   // CHAR*
  szDest: Pointer;   // CHAR* optional
  pfn: Pointer   // JET_PFNSTATUS optional
): Integer; stdcall;
  external 'ESENT.dll' name 'JetRestoreInstanceA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetRestoreInstanceA"
  c_JetRestoreInstanceA :: CUIntPtr -> Ptr Int8 -> Ptr Int8 -> Ptr () -> IO Int32
-- instance : JET_INSTANCE -> CUIntPtr
-- 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 jetrestoreinstancea =
  foreign "JetRestoreInstanceA"
    (size_t @-> (ptr int8_t) @-> (ptr int8_t) @-> (ptr void) @-> returning int32_t)
(* instance : JET_INSTANCE -> size_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 ("JetRestoreInstanceA" jet-restore-instance-a :convention :stdcall) :int32
  (instance :uint64)   ; JET_INSTANCE
  (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 $JetRestoreInstanceA = Win32::API::More->new('ESENT',
    'int JetRestoreInstanceA(WPARAM instance, LPVOID sz, LPVOID szDest, LPVOID pfn)');
# my $ret = $JetRestoreInstanceA->Call($instance, $sz, $szDest, $pfn);
# instance : JET_INSTANCE -> WPARAM
# sz : CHAR* -> LPVOID
# szDest : CHAR* optional -> LPVOID
# pfn : JET_PFNSTATUS optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

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