JetGetLogInfoW

関数

外部バックアップ対象のログファイル一覧を取得する(Unicode版)。

DLLESENT.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

INT JetGetLogInfoW(
    WORD* szzLogs,   // optional
    DWORD cbMax,
    DWORD* pcbActual   // optional
);

パラメーター

名前	型	方向	説明
szzLogs	WORD*	outoptional	バックアップ対象のログファイル一覧を受け取る出力Unicode文字列バッファポインタ。NUL区切りの多重文字列となる。
cbMax	DWORD	in	szzLogsバッファのサイズをバイト単位で指定する値。
pcbActual	DWORD*	outoptional	実際に必要/書き込まれたバイト数を受け取る出力ポインタ。

戻り値の型: INT

公式ドキュメント

JetGetLogInfo 関数は、JetBeginExternalBackup によって開始されたバックアップの実行中に、バックアップファイルセットに含めるべきデータベースパッチファイルとトランザクションログファイルの名前をインスタンスに問い合わせるために使用します。これらのファイルは、その後 JetOpenFile を使用して開き、JetReadFile を使用して読み取ることができます。

戻り値

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

戻り値コード	説明
JET_errSuccess	操作は正常に完了しました。
JET_errBackupAbortByServer	JetStopBackup の呼び出しによって現在の外部バックアップが中止されたため、操作は失敗しました。このエラーは Windows XP 以降のリリースでのみ返されます。
JET_errClientRequestToStopJetService	JetStopService の呼び出しの結果、そのセッションに関連付けられたインスタンス上のすべてのアクティビティが停止したため、操作を完了できません。
JET_errInstanceUnavailable	セッションに関連付けられたインスタンスで、データの整合性を保護するためにすべてのデータへのアクセスを取り消す必要がある致命的なエラーが発生したため、操作を完了できません。このエラーは Windows XP 以降のリリースでのみ返されます。
JET_errInvalidBackupSequence	正しい順序で呼び出されなかったため、バックアップ操作は失敗しました。JetGetLogInfo は、対象のインスタンスに対して JetOpenFile を使用して作成されたファイルハンドルが残っている場合に、このエラーを返します。
JET_errInvalidParameter	指定されたパラメーターのいずれかに予期しない値が含まれていたか、別のパラメーターの値と組み合わせたときに意味をなさない値が含まれていました。JetGetLogInfo では、指定されたインスタンスハンドルが無効な場合にこのエラーが発生することがあります (Windows XP 以降のリリース)。
JET_errNoBackup	外部バックアップが進行中ではないため、操作は失敗しました。
JET_errNotInitialized	セッションに関連付けられたインスタンスがまだ初期化されていないため、操作を完了できません。
JET_errRestoreInProgress	セッションに関連付けられたインスタンスで復元操作が進行中であるため、操作を完了できません。
JET_errRunningInMultiInstanceMode	実際には既に複数のインスタンスが存在しているにもかかわらず、1 つのインスタンスのみがサポートされるレガシモード (Windows 2000 互換モード) でエンジンを使用しようとしたため、操作は失敗しました。
JET_errTermInProgress	セッションに関連付けられたインスタンスがシャットダウン中であるため、操作を完了できません。

成功した場合、バックアップファイルセットに含めるべきデータベースパッチファイルとトランザクションログファイルのセットに関する要求された情報が、指定された出力バッファーに格納されます。バックアップのステートマシンは、データベースファイルのバックアップが許可されない状態へ進みます。これ以降は、データベースパッチファイルとトランザクションログファイルのみをバックアップのために開くことができます。

失敗した場合、出力バッファーの状態は未定義です。この失敗により、そのインスタンスに対するバックアップ処理全体が取り消されます。

解説

この API は、バックアップファイルセットに含めるべきファイルの完全な一覧を受け取るには出力バッファーが小さすぎる場合でも、エラーや警告を返さないことに注意してください。アプリケーションは、この一覧の実際のサイズを受け取るバッファーを常に指定し、その情報を使用して一覧が切り捨てられたかどうかを判断する必要があります。

要件

要件	値
クライアント	Windows Vista、Windows XP、または Windows 2000 Professional が必要です。
サーバー	Windows Server 2008、Windows Server 2003、または Windows 2000 Server が必要です。
ヘッダー	Esent.h で宣言されています。
ライブラリ	ESENT.lib を使用します。
DLL	ESENT.dll が必要です。
Unicode	JetGetLogInfoW (Unicode) および JetGetLogInfoA (ANSI) として実装されています。

各言語での呼び出し定義

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

INT JetGetLogInfoW(
    WORD* szzLogs,   // optional
    DWORD cbMax,
    DWORD* pcbActual   // optional
);

[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetGetLogInfoW(
    IntPtr szzLogs,   // WORD* optional, out
    uint cbMax,   // DWORD
    IntPtr pcbActual   // DWORD* optional, out
);

<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetGetLogInfoW(
    szzLogs As IntPtr,   ' WORD* optional, out
    cbMax As UInteger,   ' DWORD
    pcbActual As IntPtr   ' DWORD* optional, out
) As Integer
End Function

' szzLogs : WORD* optional, out
' cbMax : DWORD
' pcbActual : DWORD* optional, out
Declare PtrSafe Function JetGetLogInfoW Lib "esent" ( _
    ByVal szzLogs As LongPtr, _
    ByVal cbMax As Long, _
    ByVal pcbActual 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

JetGetLogInfoW = ctypes.windll.esent.JetGetLogInfoW
JetGetLogInfoW.restype = ctypes.c_int
JetGetLogInfoW.argtypes = [
    ctypes.POINTER(ctypes.c_ushort),  # szzLogs : WORD* optional, out
    wintypes.DWORD,  # cbMax : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbActual : DWORD* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetGetLogInfoW = Fiddle::Function.new(
  lib['JetGetLogInfoW'],
  [
    Fiddle::TYPE_VOIDP,  # szzLogs : WORD* optional, out
    -Fiddle::TYPE_INT,  # cbMax : DWORD
    Fiddle::TYPE_VOIDP,  # pcbActual : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "esent")]
extern "system" {
    fn JetGetLogInfoW(
        szzLogs: *mut u16,  // WORD* optional, out
        cbMax: u32,  // DWORD
        pcbActual: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ESENT.dll", CharSet = CharSet.Unicode)]
public static extern int JetGetLogInfoW(IntPtr szzLogs, uint cbMax, IntPtr pcbActual);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetGetLogInfoW' -Namespace Win32 -PassThru
# $api::JetGetLogInfoW(szzLogs, cbMax, pcbActual)

#uselib "ESENT.dll"
#func global JetGetLogInfoW "JetGetLogInfoW" wptr, wptr, wptr
; JetGetLogInfoW varptr(szzLogs), cbMax, varptr(pcbActual)   ; 戻り値は stat
; szzLogs : WORD* optional, out -> "wptr"
; cbMax : DWORD -> "wptr"
; pcbActual : DWORD* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ESENT.dll"
#cfunc global JetGetLogInfoW "JetGetLogInfoW" var, int, var
; res = JetGetLogInfoW(szzLogs, cbMax, pcbActual)
; szzLogs : WORD* optional, out -> "var"
; cbMax : DWORD -> "int"
; pcbActual : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ESENT.dll"
#cfunc global JetGetLogInfoW "JetGetLogInfoW" sptr, int, sptr
; res = JetGetLogInfoW(varptr(szzLogs), cbMax, varptr(pcbActual))
; szzLogs : WORD* optional, out -> "sptr"
; cbMax : DWORD -> "int"
; pcbActual : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。