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

JetBeginExternalBackup

関数
外部バックアップセッションを開始する。
DLLESENT.dll呼出規約winapi

シグネチャ

// ESENT.dll
#include <windows.h>

INT JetBeginExternalBackup(
    DWORD grbit
);

パラメーター

名前型方向説明
grbitDWORDin外部バックアップ開始動作を制御するビットフラグ。JET_bitBackupIncremental等で増分などを指定する。

戻り値の型: INT

公式ドキュメント

JetBeginExternalBackup 関数は、エンジンとデータベースがオンラインかつアクティブな状態のまま外部バックアップを開始します。JetBeginExternalBackup は、オンライン (VSS を使用しない) バックアップを正常に実行するために呼び出す必要がある一連の関数のうち、最初のものです。

戻り値

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

戻りコード

説明

JET_errSuccess

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

JET_errBackupInProgress

外部バックアップまたはスナップショットバックアップが既に実行中の場合、JetBeginExternalBackup (またはそのバリエーションのいずれか) が呼び出されるまで、このエラーが返されます。ESE では同時に 1 つのオンラインバックアップのみが許可されます。

JET_errBackupNotAllowedYet

インスタンスまたはデータベースエンジンが、回復処理中であるか、シャットダウンまたは終了のフェーズにあります。

JET_errCheckpointCorrupt

フルバックアップにおいて、チェックポイントファイルを読み取れなかったか、ファイルを検証できませんでした。

JET_errCheckpointFileNotFound

フルバックアップにおいて、チェックポイントファイルが見つかりませんでした。

JET_errClientRequestToStopJetService

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

JET_errInstanceUnavailable

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

Windows XP: この戻り値は Windows XP で導入されました。

JET_errInvalidBackup

循環ログが有効になっており、指定されたバックアップの種類が JET_bitBackupIncremental です。循環ログまたは非循環ログを制御する方法については、Transaction Log Errors の JET_paramCircularLog を参照してください。

JET_errInvalidgrbit

grbit のメンバーのうち 1 つ以上が無効でした。

JET_errLoggingDisabled

回復処理またはログ記録が無効になっています。ログ記録が無効な場合、オンラインバックアップを実行することはできません。ログ記録と回復処理について詳しくは、JET_paramRecovery を参照してください。

JET_errLogWriteFail

ログがいっぱいであるか、ディスク I/O エラーが発生したため、エンジンがログドライブへの書き込みを停止しました。

JET_errMissingFullBackup

増分バックアップが (JET_bitBackupIncremental によって) 指定されましたが、そのログセットに対してアタッチされているデータベースのいずれかについて、フルバックアップが一度も実行されていません。

JET_errNotInitialized

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

JET_errOutOfMemory

操作を完了するのに十分なメモリを割り当てられなかったため、操作が失敗しました。

JET_errRestoreInProgress

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

JET_errRunningInMultiInstanceMode

実際には複数のインスタンスが既に存在しているにもかかわらず、1 つのインスタンスのみがサポートされるレガシーモード (Windows 2000 互換モード) でエンジンを使用しようとしたため、操作が失敗しました。

JET_errTermInProgress

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

関数が成功すると、外部バックアップが開始され、バックアップ状態エンジンが初期化されます。以降は、外部バックアップの一連の処理を完了し、データベースファイル、データベースパッチファイル (サポートされている場合)、およびログファイルをストリーミングまたは読み出すための API を呼び出せるようになります。外部バックアップが開始されたことを示すイベントがログに記録される場合があります。

関数が失敗した場合、バックアップセッションは開始されません。別のバックアップセッションが進行中の場合でも、それがキャンセルされることはありません。

解説

(JetBeginExternalBackup によって開始される) 外部バックアップ処理は、インスタンス全体のファジートランザクションオンラインバックアップを、ストリームとして対象デバイスへ実行できるように設計されています。バックアップには、(フルバックアップの場合) JetAttachDatabase によってインスタンスにアタッチされているすべてのデータベースファイルが含まれ、続いてそれらに関連付けられたデータベースパッチファイル (サポートされている場合)、最後にバックアップ処理中に生成されたトランザクションログファイルが含まれます。最終的な結果として、ストリームから復元でき、場合によっては既存のデータベースファイルやログファイルと組み合わせたうえで、最終的に一貫性のある状態へ回復できる一連のファイルが得られます。

フルバックアップにおける一般的な処理の順序は、次の呼び出しで構成されます。まず、バックアップ処理を開始するために JetBeginExternalBackup を呼び出します。次に、バックアップ対象となるインスタンスにアタッチされているデータベースの一覧を取得するために JetGetAttachInfo を呼び出します。これらの各データベースについて、JetOpenFile を呼び出し、続いて JetReadFile を複数回呼び出し、その後 JetCloseFile を呼び出します。次に、バックアップ対象となるデータベースパッチファイルとログファイルの一覧を取得するために JetGetLogInfo を呼び出します。これらの各ファイルについても、JetOpenFile、JetReadFile、JetCloseFile という一連の呼び出しを行います。次に、不要なトランザクションログファイルを JetTruncateLog によって削除します。最後に、JetEndExternalBackup を呼び出してバックアップを終了します。

この一連の手順を変更して、インスタンスの増分バックアップを実行することもできます。増分バックアップでは、ログファイルを列挙してバックアップします。増分バックアップは、循環ログが有効になっていない場合にのみ実行できます。

また、この一連の手順を変更して、インスタンスの差分バックアップを以降実行できるようにすることも可能です。差分バックアップを実行するには、直前のフルバックアップまたは増分バックアップで JetTruncateLog を呼び出さないでください。JetTruncateLog を呼び出さないことで、以降のバックアップを、最後のフルバックアップまたは増分バックアップに対する差分バックアップにできます。差分バックアップは、循環ログが有効になっていない場合にのみ実行できます。

データベースパッチファイルは、バックアップ中の特定の状況下でデータベースページのイメージを格納するために使用される、特別な補助ファイルです。このファイルは、復元操作の際に、関連付けられたデータベースと同じ場所に存在している必要があります。このファイルは Windows 2000 でのみ使用されます。そのため、Windows 2000 とそれ以外のリリースの両方で動作するように記述されたアプリケーションは、データベースパッチファイルが存在する場合にはそれをサポートしなければならず、また存在しない場合にも失敗してはなりません。

要件

要件 値

クライアント

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

サーバー

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

ヘッダー

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

ライブラリ

ESENT.lib を使用します。

DLL

ESENT.dll が必要です。

関連項目

JET_ERR
JET_GRBIT
JET_INSTANCE
JetAttachDatabase
JetBeginExternalBackupInstance
JetCloseFile
JetEndExternalBackup
JetEndExternalBackupInstance2
JetGetAttachInfo
JetGetLogInfo
JetOpenFile
JetReadFile
JetStopBackup
JetTruncateLog

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

各言語での呼び出し定義

// ESENT.dll
#include <windows.h>

INT JetBeginExternalBackup(
    DWORD grbit
);
[DllImport("ESENT.dll", ExactSpelling = true)]
static extern int JetBeginExternalBackup(
    uint grbit   // DWORD
);
<DllImport("ESENT.dll", ExactSpelling:=True)>
Public Shared Function JetBeginExternalBackup(
    grbit As UInteger   ' DWORD
) As Integer
End Function
' grbit : DWORD
Declare PtrSafe Function JetBeginExternalBackup Lib "esent" ( _
    ByVal grbit As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

JetBeginExternalBackup = ctypes.windll.esent.JetBeginExternalBackup
JetBeginExternalBackup.restype = ctypes.c_int
JetBeginExternalBackup.argtypes = [
    wintypes.DWORD,  # grbit : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetBeginExternalBackup = Fiddle::Function.new(
  lib['JetBeginExternalBackup'],
  [
    -Fiddle::TYPE_INT,  # grbit : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "esent")]
extern "system" {
    fn JetBeginExternalBackup(
        grbit: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ESENT.dll")]
public static extern int JetBeginExternalBackup(uint grbit);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetBeginExternalBackup' -Namespace Win32 -PassThru
# $api::JetBeginExternalBackup(grbit)
#uselib "ESENT.dll"
#func global JetBeginExternalBackup "JetBeginExternalBackup" sptr
; JetBeginExternalBackup grbit   ; 戻り値は stat
; grbit : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ESENT.dll"
#cfunc global JetBeginExternalBackup "JetBeginExternalBackup" int
; res = JetBeginExternalBackup(grbit)
; grbit : DWORD -> "int"
; INT JetBeginExternalBackup(DWORD grbit)
#uselib "ESENT.dll"
#cfunc global JetBeginExternalBackup "JetBeginExternalBackup" int
; res = JetBeginExternalBackup(grbit)
; grbit : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetBeginExternalBackup = esent.NewProc("JetBeginExternalBackup")
)

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

extern "esent" fn JetBeginExternalBackup(
    grbit: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc JetBeginExternalBackup(
    grbit: uint32  # DWORD
): int32 {.importc: "JetBeginExternalBackup", stdcall, dynlib: "ESENT.dll".}
pragma(lib, "esent");
extern(Windows)
int JetBeginExternalBackup(
    uint grbit   // DWORD
);
ccall((:JetBeginExternalBackup, "ESENT.dll"), stdcall, Int32,
      (UInt32,),
      grbit)
# grbit : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetBeginExternalBackup(
    uint32_t grbit);
]]
local esent = ffi.load("esent")
-- esent.JetBeginExternalBackup(grbit)
-- grbit : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetBeginExternalBackup = lib.func('__stdcall', 'JetBeginExternalBackup', 'int32_t', ['uint32_t']);
// JetBeginExternalBackup(grbit)
// grbit : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetBeginExternalBackup: { parameters: ["u32"], result: "i32" },
});
// lib.symbols.JetBeginExternalBackup(grbit)
// grbit : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetBeginExternalBackup(
    uint32_t grbit);
C, "ESENT.dll");
// $ffi->JetBeginExternalBackup(grbit);
// grbit : DWORD
// 構造体/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);
    int JetBeginExternalBackup(
        int grbit   // DWORD
    );
}
@[Link("esent")]
lib LibESENT
  fun JetBeginExternalBackup = JetBeginExternalBackup(
    grbit : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef JetBeginExternalBackupNative = Int32 Function(Uint32);
typedef JetBeginExternalBackupDart = int Function(int);
final JetBeginExternalBackup = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetBeginExternalBackupNative, JetBeginExternalBackupDart>('JetBeginExternalBackup');
// grbit : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetBeginExternalBackup(
  grbit: DWORD   // DWORD
): Integer; stdcall;
  external 'ESENT.dll' name 'JetBeginExternalBackup';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetBeginExternalBackup"
  c_JetBeginExternalBackup :: Word32 -> IO Int32
-- grbit : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetbeginexternalbackup =
  foreign "JetBeginExternalBackup"
    (uint32_t @-> returning int32_t)
(* grbit : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library esent (t "ESENT.dll"))
(cffi:use-foreign-library esent)

(cffi:defcfun ("JetBeginExternalBackup" jet-begin-external-backup :convention :stdcall) :int32
  (grbit :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetBeginExternalBackup = Win32::API::More->new('ESENT',
    'int JetBeginExternalBackup(DWORD grbit)');
# my $ret = $JetBeginExternalBackup->Call($grbit);
# grbit : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。