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

JetBackupInstanceA

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

シグネチャ

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

INT JetBackupInstanceA(
    JET_INSTANCE instance,
    CHAR* szBackupPath,
    DWORD grbit,
    JET_PFNSTATUS pfnStatus   // optional
);

パラメーター

名前型方向説明
instanceJET_INSTANCEinバックアップ対象のインスタンスを識別するJET_INSTANCEハンドル。
szBackupPathCHAR*inバックアップ出力先ディレクトリのパスを指す終端付きANSI文字列ポインタ。
grbitDWORDinバックアップ動作を制御するビットフラグ。増分や完全などを指定する。
pfnStatusJET_PFNSTATUSinoptional進捗通知を受け取るステータスコールバック関数(JET_PFNSTATUS)。NULL可。

戻り値の型: INT

公式ドキュメント

JetBackupInstance 関数は、アタッチされているすべてのデータベースを含むインスタンスのストリーミングバックアップを、指定したディレクトリに対して実行します。エンジンがサポートする複数のバックアップ方法の中で、これが最も単純でカプセル化された関数です。

戻り値

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

リターンコード

説明

JET_errSuccess

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

JET_errBackupInProgress

同じインスタンスに対するバックアップが既に進行中です。複数のバックアップを同時に実行することはできません。

JET_errBackupNotAllowedYet

インスタンスは初期化中であり、まだバックアップを実行できる状態ではありません。

JET_errClientRequestToStopJetService

JetStopServiceInstance の呼び出しによって、セッションに関連付けられたインスタンス上のすべての動作が停止したため、操作を完了できません。

JET_errInstanceUnavailable

セッションに関連付けられたインスタンスで、データの整合性を保護するためにすべてのデータへのアクセスを取り消す必要がある致命的なエラーが発生したため、操作を完了できません。

Windows XP: このリターン値は Windows XP で導入されました。

JET_errInvalidBackup

循環ログ記録が有効な場合、増分バックアップは実行できません。

JET_errInvalidGrbit

指定されたオプションが無効です。

JET_errInvalidParameter

無効なパラメーターが API に渡されました。

JET_errInvalidPath

出力先のパスが存在しません。

JET_errLoggingDisabled

インスタンスはログ記録なしで実行されています。バックアップは実行できません。

JET_errLogReadVerifyFailure

ログファイルでチェックサムの検証エラーが発生しました。

JET_errLogWriteFail

予期しないエラーにより、インスタンスのログ記録が一時的または永続的に無効になっています。

JET_errNotInitialized

セッションに関連付けられたインスタンスがまだ初期化されていないため、操作を完了できません。

JET_errReadVerifyFailure

データベースページでチェックサムの検証エラーが発生しました。

JET_errRestoreInProgress

セッションに関連付けられたインスタンスで復元操作が進行中のため、操作を完了できません。

JET_errSessionSharingViolation

同じセッションを複数のスレッドで同時に使用することはできません。

Windows XP: このリターン値は Windows XP で導入されました。

JET_errTermInProgress

セッションに関連付けられたインスタンスがシャットダウン中のため、操作を完了できません。

関数が成功を返した後、バックアップディレクトリには、バックアップ時点までの復元に必要なすべてのファイルが格納されています。フルバックアップの場合、そのファイルはデータベースファイルと、データベースを整合性のある状態にするために必要なログファイルです。増分バックアップの場合、ディレクトリに追加されるのはログファイルのみですが、既に存在するファイル (データベースおよびログファイル) と新しいログファイルを合わせて復元することで、バックアップ時点の状態にデータベースを戻すことができます。

バックアップの副作用として、不要になったログファイルは切り捨てられます。

同時に、データベースヘッダーは最後にバックアップが行われた時点の情報で更新されます。

失敗した場合、バックアップ先のディレクトリにはファイルが一切作成されないため、復元は行えません。またこの場合、現在のログファイルは切り捨てられません。

解説

バックアップの各段階では、ファイル名、ログの切り捨て、バックアップの最終結果を含むイベントログエントリが生成されます。

増分バックアップは、フルバックアップを取得した後にのみ実行できます。また、増分バックアップは循環ログ記録が無効になっている場合にのみ実行できます。バックアップディレクトリには、そのバックアップに関係するファイル、または以前の成功したバックアップによって追加されたファイル以外を置かないことをお勧めします。

インスタンスに JET_paramCreatePathIfNotExist パラメーターが設定されていない限り、バックアップディレクトリはあらかじめ存在している必要があります。詳細については、「System Parameters」を参照してください。

バックアップでは、使用中のすべてのデータベースページに対してチェックサムの検証が行われ、Windows Server 2003 以降ではログファイルに対しても行われます。これにより、通常の操作では読み取られないページについてもデータベースの健全性を評価する機会が得られます。そのような破損が検出された場合、バックアップは失敗します。

バックアップ中は、現在のログファイルが終了され、新しいログ世代が開始されます。これにより、必要な最後のログファイルが使用中ではなくなるため、必要なログファイルをコピーできます。

バックアップは、エンジンレベルでのバックアップと復元以外の目的には使用しないことを強くお勧めします。これにより、バックアップおよび復元操作中にエラーが発生する可能性を最小限に抑えられます。

要件

要件 値

クライアント

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

サーバー

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

ヘッダー

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

ライブラリ

ESENT.lib を使用します。

DLL

ESENT.dll が必要です。

Unicode

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

関連項目

JET_ERR
JET_GRBIT
JET_INSTANCE
JET_PFNSTATUS
JetRestore
JetRestore2
JetRestoreInstance
JetStopServiceInstance
System Parameters

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 JetBackupInstanceA(
    JET_INSTANCE instance,
    CHAR* szBackupPath,
    DWORD grbit,
    JET_PFNSTATUS pfnStatus   // optional
);
[DllImport("ESENT.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int JetBackupInstanceA(
    UIntPtr instance,   // JET_INSTANCE
    IntPtr szBackupPath,   // CHAR*
    uint grbit,   // DWORD
    IntPtr pfnStatus   // JET_PFNSTATUS optional
);
<DllImport("ESENT.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function JetBackupInstanceA(
    instance As UIntPtr,   ' JET_INSTANCE
    szBackupPath As IntPtr,   ' CHAR*
    grbit As UInteger,   ' DWORD
    pfnStatus As IntPtr   ' JET_PFNSTATUS optional
) As Integer
End Function
' instance : JET_INSTANCE
' szBackupPath : CHAR*
' grbit : DWORD
' pfnStatus : JET_PFNSTATUS optional
Declare PtrSafe Function JetBackupInstanceA Lib "esent" ( _
    ByVal instance As LongPtr, _
    ByVal szBackupPath As LongPtr, _
    ByVal grbit As Long, _
    ByVal pfnStatus As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

JetBackupInstanceA = ctypes.windll.esent.JetBackupInstanceA
JetBackupInstanceA.restype = ctypes.c_int
JetBackupInstanceA.argtypes = [
    ctypes.c_size_t,  # instance : JET_INSTANCE
    ctypes.POINTER(ctypes.c_byte),  # szBackupPath : CHAR*
    wintypes.DWORD,  # grbit : DWORD
    ctypes.c_void_p,  # pfnStatus : JET_PFNSTATUS optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetBackupInstanceA = Fiddle::Function.new(
  lib['JetBackupInstanceA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # instance : JET_INSTANCE
    Fiddle::TYPE_VOIDP,  # szBackupPath : CHAR*
    -Fiddle::TYPE_INT,  # grbit : DWORD
    Fiddle::TYPE_VOIDP,  # pfnStatus : JET_PFNSTATUS optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "esent")]
extern "system" {
    fn JetBackupInstanceA(
        instance: usize,  // JET_INSTANCE
        szBackupPath: *mut i8,  // CHAR*
        grbit: u32,  // DWORD
        pfnStatus: *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 JetBackupInstanceA(UIntPtr instance, IntPtr szBackupPath, uint grbit, IntPtr pfnStatus);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetBackupInstanceA' -Namespace Win32 -PassThru
# $api::JetBackupInstanceA(instance, szBackupPath, grbit, pfnStatus)
#uselib "ESENT.dll"
#func global JetBackupInstanceA "JetBackupInstanceA" sptr, sptr, sptr, sptr
; JetBackupInstanceA instance, varptr(szBackupPath), grbit, pfnStatus   ; 戻り値は stat
; instance : JET_INSTANCE -> "sptr"
; szBackupPath : CHAR* -> "sptr"
; grbit : DWORD -> "sptr"
; pfnStatus : JET_PFNSTATUS optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ESENT.dll"
#cfunc global JetBackupInstanceA "JetBackupInstanceA" sptr, var, int, sptr
; res = JetBackupInstanceA(instance, szBackupPath, grbit, pfnStatus)
; instance : JET_INSTANCE -> "sptr"
; szBackupPath : CHAR* -> "var"
; grbit : DWORD -> "int"
; pfnStatus : JET_PFNSTATUS optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT JetBackupInstanceA(JET_INSTANCE instance, CHAR* szBackupPath, DWORD grbit, JET_PFNSTATUS pfnStatus)
#uselib "ESENT.dll"
#cfunc global JetBackupInstanceA "JetBackupInstanceA" intptr, var, int, intptr
; res = JetBackupInstanceA(instance, szBackupPath, grbit, pfnStatus)
; instance : JET_INSTANCE -> "intptr"
; szBackupPath : CHAR* -> "var"
; grbit : DWORD -> "int"
; pfnStatus : JET_PFNSTATUS optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetBackupInstanceA = esent.NewProc("JetBackupInstanceA")
)

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

extern "esent" fn JetBackupInstanceA(
    instance: usize, // JET_INSTANCE
    szBackupPath: [*c]i8, // CHAR*
    grbit: u32, // DWORD
    pfnStatus: ?*anyopaque // JET_PFNSTATUS optional
) callconv(std.os.windows.WINAPI) i32;
proc JetBackupInstanceA(
    instance: uint,  # JET_INSTANCE
    szBackupPath: ptr int8,  # CHAR*
    grbit: uint32,  # DWORD
    pfnStatus: pointer  # JET_PFNSTATUS optional
): int32 {.importc: "JetBackupInstanceA", stdcall, dynlib: "ESENT.dll".}
pragma(lib, "esent");
extern(Windows)
int JetBackupInstanceA(
    size_t instance,   // JET_INSTANCE
    byte* szBackupPath,   // CHAR*
    uint grbit,   // DWORD
    void* pfnStatus   // JET_PFNSTATUS optional
);
ccall((:JetBackupInstanceA, "ESENT.dll"), stdcall, Int32,
      (Csize_t, Ptr{Int8}, UInt32, Ptr{Cvoid}),
      instance, szBackupPath, grbit, pfnStatus)
# instance : JET_INSTANCE -> Csize_t
# szBackupPath : CHAR* -> Ptr{Int8}
# grbit : DWORD -> UInt32
# pfnStatus : JET_PFNSTATUS optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetBackupInstanceA(
    uintptr_t instance,
    int8_t* szBackupPath,
    uint32_t grbit,
    void* pfnStatus);
]]
local esent = ffi.load("esent")
-- esent.JetBackupInstanceA(instance, szBackupPath, grbit, pfnStatus)
-- instance : JET_INSTANCE
-- szBackupPath : CHAR*
-- grbit : DWORD
-- pfnStatus : JET_PFNSTATUS optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetBackupInstanceA = lib.func('__stdcall', 'JetBackupInstanceA', 'int32_t', ['uintptr_t', 'int8_t *', 'uint32_t', 'void *']);
// JetBackupInstanceA(instance, szBackupPath, grbit, pfnStatus)
// instance : JET_INSTANCE -> 'uintptr_t'
// szBackupPath : CHAR* -> 'int8_t *'
// grbit : DWORD -> 'uint32_t'
// pfnStatus : JET_PFNSTATUS optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("ESENT.dll", {
  JetBackupInstanceA: { parameters: ["usize", "pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.JetBackupInstanceA(instance, szBackupPath, grbit, pfnStatus)
// instance : JET_INSTANCE -> "usize"
// szBackupPath : CHAR* -> "pointer"
// grbit : DWORD -> "u32"
// pfnStatus : JET_PFNSTATUS optional -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetBackupInstanceA(
    size_t instance,
    int8_t* szBackupPath,
    uint32_t grbit,
    void* pfnStatus);
C, "ESENT.dll");
// $ffi->JetBackupInstanceA(instance, szBackupPath, grbit, pfnStatus);
// instance : JET_INSTANCE
// szBackupPath : CHAR*
// grbit : DWORD
// pfnStatus : 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 JetBackupInstanceA(
        long instance,   // JET_INSTANCE
        byte[] szBackupPath,   // CHAR*
        int grbit,   // DWORD
        Callback pfnStatus   // JET_PFNSTATUS optional
    );
}
@[Link("esent")]
lib LibESENT
  fun JetBackupInstanceA = JetBackupInstanceA(
    instance : LibC::SizeT,   # JET_INSTANCE
    szBackupPath : Int8*,   # CHAR*
    grbit : UInt32,   # DWORD
    pfnStatus : 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 JetBackupInstanceANative = Int32 Function(UintPtr, Pointer<Int8>, Uint32, Pointer<Void>);
typedef JetBackupInstanceADart = int Function(int, Pointer<Int8>, int, Pointer<Void>);
final JetBackupInstanceA = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetBackupInstanceANative, JetBackupInstanceADart>('JetBackupInstanceA');
// instance : JET_INSTANCE -> UintPtr
// szBackupPath : CHAR* -> Pointer<Int8>
// grbit : DWORD -> Uint32
// pfnStatus : JET_PFNSTATUS optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetBackupInstanceA(
  instance: NativeUInt;   // JET_INSTANCE
  szBackupPath: Pointer;   // CHAR*
  grbit: DWORD;   // DWORD
  pfnStatus: Pointer   // JET_PFNSTATUS optional
): Integer; stdcall;
  external 'ESENT.dll' name 'JetBackupInstanceA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetBackupInstanceA"
  c_JetBackupInstanceA :: CUIntPtr -> Ptr Int8 -> Word32 -> Ptr () -> IO Int32
-- instance : JET_INSTANCE -> CUIntPtr
-- szBackupPath : CHAR* -> Ptr Int8
-- grbit : DWORD -> Word32
-- pfnStatus : JET_PFNSTATUS optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetbackupinstancea =
  foreign "JetBackupInstanceA"
    (size_t @-> (ptr int8_t) @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* instance : JET_INSTANCE -> size_t *)
(* szBackupPath : CHAR* -> (ptr int8_t) *)
(* grbit : DWORD -> uint32_t *)
(* pfnStatus : 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 ("JetBackupInstanceA" jet-backup-instance-a :convention :stdcall) :int32
  (instance :uint64)   ; JET_INSTANCE
  (sz-backup-path :pointer)   ; CHAR*
  (grbit :uint32)   ; DWORD
  (pfn-status :pointer))   ; JET_PFNSTATUS optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetBackupInstanceA = Win32::API::More->new('ESENT',
    'int JetBackupInstanceA(WPARAM instance, LPVOID szBackupPath, DWORD grbit, LPVOID pfnStatus)');
# my $ret = $JetBackupInstanceA->Call($instance, $szBackupPath, $grbit, $pfnStatus);
# instance : JET_INSTANCE -> WPARAM
# szBackupPath : CHAR* -> LPVOID
# grbit : DWORD -> DWORD
# pfnStatus : JET_PFNSTATUS optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

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