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

JetBackupW

関数
データベースをバックアップする(Unicode版)。
DLLESENT.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

INT JetBackupW(
    WORD* szBackupPath,
    DWORD grbit,
    JET_PFNSTATUS pfnStatus   // optional
);

パラメーター

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

戻り値の型: INT

公式ドキュメント

JetBackup 関数は、データベースがオンラインの状態のままデータベースのバックアップを作成します。この関数は主に、データベースのインスタンスを 1 つしか持てない Windows 2000 以前のデータベース エンジンとの下位互換性のために用意されています。この場合、バックアップされるのはアクティブなインスタンスです。

戻り値

この関数は JET_ERR エラー コードのいずれかを返します。以下は特に多く返されるものです。(この API が返すエラーの完全な一覧については、Extensible Storage Engine のエラー コード を参照してください。)

戻り値

説明

JET_errSuccess

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

JET_errBackupInProgress

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

JET_errBackupNotAllowedYet

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

JET_errClientRequestToStopJetService

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

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 パラメーターが設定されていない限り、あらかじめ存在している必要があります。詳細については、システム パラメーター を参照してください。

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

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

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

要件

要件 値

クライアント

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

サーバー

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

ヘッダー

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

ライブラリ

ESENT.lib を使用します。

DLL

ESENT.dll が必要です。

Unicode

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

関連項目

Extensible Storage Engine のファイル
JET_ERR
JET_GRBIT
JET_INSTANCE
JET_PFNSTATUS
JetRestore
JetRestore2
JetRestoreInstance
JetStopService
システム パラメーター

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

各言語での呼び出し定義

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

INT JetBackupW(
    WORD* szBackupPath,
    DWORD grbit,
    JET_PFNSTATUS pfnStatus   // optional
);
[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetBackupW(
    ref ushort szBackupPath,   // WORD*
    uint grbit,   // DWORD
    IntPtr pfnStatus   // JET_PFNSTATUS optional
);
<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetBackupW(
    ByRef szBackupPath As UShort,   ' WORD*
    grbit As UInteger,   ' DWORD
    pfnStatus As IntPtr   ' JET_PFNSTATUS optional
) As Integer
End Function
' szBackupPath : WORD*
' grbit : DWORD
' pfnStatus : JET_PFNSTATUS optional
Declare PtrSafe Function JetBackupW Lib "esent" ( _
    ByRef szBackupPath As Integer, _
    ByVal grbit As Long, _
    ByVal pfnStatus As LongPtr) 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

JetBackupW = ctypes.windll.esent.JetBackupW
JetBackupW.restype = ctypes.c_int
JetBackupW.argtypes = [
    ctypes.POINTER(ctypes.c_ushort),  # szBackupPath : WORD*
    wintypes.DWORD,  # grbit : DWORD
    ctypes.c_void_p,  # pfnStatus : JET_PFNSTATUS optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetBackupW = Fiddle::Function.new(
  lib['JetBackupW'],
  [
    Fiddle::TYPE_VOIDP,  # szBackupPath : WORD*
    -Fiddle::TYPE_INT,  # grbit : DWORD
    Fiddle::TYPE_VOIDP,  # pfnStatus : JET_PFNSTATUS optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "esent")]
extern "system" {
    fn JetBackupW(
        szBackupPath: *mut u16,  // WORD*
        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.Unicode)]
public static extern int JetBackupW(ref ushort szBackupPath, uint grbit, IntPtr pfnStatus);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetBackupW' -Namespace Win32 -PassThru
# $api::JetBackupW(szBackupPath, grbit, pfnStatus)
#uselib "ESENT.dll"
#func global JetBackupW "JetBackupW" wptr, wptr, wptr
; JetBackupW varptr(szBackupPath), grbit, pfnStatus   ; 戻り値は stat
; szBackupPath : WORD* -> "wptr"
; grbit : DWORD -> "wptr"
; pfnStatus : JET_PFNSTATUS optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ESENT.dll"
#cfunc global JetBackupW "JetBackupW" var, int, sptr
; res = JetBackupW(szBackupPath, grbit, pfnStatus)
; szBackupPath : WORD* -> "var"
; grbit : DWORD -> "int"
; pfnStatus : JET_PFNSTATUS optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT JetBackupW(WORD* szBackupPath, DWORD grbit, JET_PFNSTATUS pfnStatus)
#uselib "ESENT.dll"
#cfunc global JetBackupW "JetBackupW" var, int, intptr
; res = JetBackupW(szBackupPath, grbit, pfnStatus)
; szBackupPath : WORD* -> "var"
; grbit : DWORD -> "int"
; pfnStatus : JET_PFNSTATUS optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetBackupW = esent.NewProc("JetBackupW")
)

// szBackupPath (WORD*), grbit (DWORD), pfnStatus (JET_PFNSTATUS optional)
r1, _, err := procJetBackupW.Call(
	uintptr(szBackupPath),
	uintptr(grbit),
	uintptr(pfnStatus),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function JetBackupW(
  szBackupPath: Pointer;   // WORD*
  grbit: DWORD;   // DWORD
  pfnStatus: Pointer   // JET_PFNSTATUS optional
): Integer; stdcall;
  external 'ESENT.dll' name 'JetBackupW';
result := DllCall("ESENT\JetBackupW"
    , "Ptr", szBackupPath   ; WORD*
    , "UInt", grbit   ; DWORD
    , "Ptr", pfnStatus   ; JET_PFNSTATUS optional
    , "Int")   ; return: INT
●JetBackupW(szBackupPath, grbit, pfnStatus) = DLL("ESENT.dll", "int JetBackupW(void*, dword, void*)")
# 呼び出し: JetBackupW(szBackupPath, grbit, pfnStatus)
# szBackupPath : WORD* -> "void*"
# grbit : DWORD -> "dword"
# pfnStatus : JET_PFNSTATUS optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "esent" fn JetBackupW(
    szBackupPath: [*c]u16, // WORD*
    grbit: u32, // DWORD
    pfnStatus: ?*anyopaque // JET_PFNSTATUS optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc JetBackupW(
    szBackupPath: ptr uint16,  # WORD*
    grbit: uint32,  # DWORD
    pfnStatus: pointer  # JET_PFNSTATUS optional
): int32 {.importc: "JetBackupW", stdcall, dynlib: "ESENT.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "esent");
extern(Windows)
int JetBackupW(
    ushort* szBackupPath,   // WORD*
    uint grbit,   // DWORD
    void* pfnStatus   // JET_PFNSTATUS optional
);
ccall((:JetBackupW, "ESENT.dll"), stdcall, Int32,
      (Ptr{UInt16}, UInt32, Ptr{Cvoid}),
      szBackupPath, grbit, pfnStatus)
# szBackupPath : WORD* -> Ptr{UInt16}
# grbit : DWORD -> UInt32
# pfnStatus : JET_PFNSTATUS optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetBackupW(
    uint16_t* szBackupPath,
    uint32_t grbit,
    void* pfnStatus);
]]
local esent = ffi.load("esent")
-- esent.JetBackupW(szBackupPath, grbit, pfnStatus)
-- szBackupPath : WORD*
-- grbit : DWORD
-- pfnStatus : JET_PFNSTATUS optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetBackupW = lib.func('__stdcall', 'JetBackupW', 'int32_t', ['uint16_t *', 'uint32_t', 'void *']);
// JetBackupW(szBackupPath, grbit, pfnStatus)
// szBackupPath : WORD* -> 'uint16_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", {
  JetBackupW: { parameters: ["pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.JetBackupW(szBackupPath, grbit, pfnStatus)
// szBackupPath : WORD* -> "pointer"
// grbit : DWORD -> "u32"
// pfnStatus : JET_PFNSTATUS optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetBackupW(
    uint16_t* szBackupPath,
    uint32_t grbit,
    void* pfnStatus);
C, "ESENT.dll");
// $ffi->JetBackupW(szBackupPath, grbit, pfnStatus);
// szBackupPath : WORD*
// 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.UNICODE_OPTIONS);
    int JetBackupW(
        ShortByReference szBackupPath,   // WORD*
        int grbit,   // DWORD
        Callback pfnStatus   // JET_PFNSTATUS optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("esent")]
lib LibESENT
  fun JetBackupW = JetBackupW(
    szBackupPath : UInt16*,   # WORD*
    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 JetBackupWNative = Int32 Function(Pointer<Uint16>, Uint32, Pointer<Void>);
typedef JetBackupWDart = int Function(Pointer<Uint16>, int, Pointer<Void>);
final JetBackupW = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetBackupWNative, JetBackupWDart>('JetBackupW');
// szBackupPath : WORD* -> Pointer<Uint16>
// grbit : DWORD -> Uint32
// pfnStatus : JET_PFNSTATUS optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetBackupW(
  szBackupPath: Pointer;   // WORD*
  grbit: DWORD;   // DWORD
  pfnStatus: Pointer   // JET_PFNSTATUS optional
): Integer; stdcall;
  external 'ESENT.dll' name 'JetBackupW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let jetbackupw =
  foreign "JetBackupW"
    ((ptr uint16_t) @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* szBackupPath : WORD* -> (ptr uint16_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 ("JetBackupW" jet-backup-w :convention :stdcall) :int32
  (sz-backup-path :pointer)   ; WORD*
  (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 $JetBackupW = Win32::API::More->new('ESENT',
    'int JetBackupW(LPVOID szBackupPath, DWORD grbit, LPVOID pfnStatus)');
# my $ret = $JetBackupW->Call($szBackupPath, $grbit, $pfnStatus);
# szBackupPath : WORD* -> LPVOID
# grbit : DWORD -> DWORD
# pfnStatus : JET_PFNSTATUS optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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