JetGetLogInfoA

関数

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

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

シグネチャ

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

INT JetGetLogInfoA(
    CHAR* szzLogs,   // optional
    DWORD cbMax,
    DWORD* pcbActual   // optional
);

パラメーター

名前	型	方向	説明
szzLogs	CHAR*	outoptional	バックアップ対象のログファイル一覧を受け取る出力ANSI文字列バッファポインタ。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  (ANSI / -A)
#include <windows.h>

INT JetGetLogInfoA(
    CHAR* szzLogs,   // optional
    DWORD cbMax,
    DWORD* pcbActual   // optional
);

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

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

' szzLogs : CHAR* optional, out
' cbMax : DWORD
' pcbActual : DWORD* optional, out
Declare PtrSafe Function JetGetLogInfoA Lib "esent" ( _
    ByVal szzLogs As LongPtr, _
    ByVal cbMax As Long, _
    ByVal pcbActual As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetGetLogInfoA = Fiddle::Function.new(
  lib['JetGetLogInfoA'],
  [
    Fiddle::TYPE_VOIDP,  # szzLogs : CHAR* optional, out
    -Fiddle::TYPE_INT,  # cbMax : DWORD
    Fiddle::TYPE_VOIDP,  # pcbActual : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "esent")]
extern "system" {
    fn JetGetLogInfoA(
        szzLogs: *mut i8,  // CHAR* 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.Ansi)]
public static extern int JetGetLogInfoA(IntPtr szzLogs, uint cbMax, IntPtr pcbActual);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetGetLogInfoA' -Namespace Win32 -PassThru
# $api::JetGetLogInfoA(szzLogs, cbMax, pcbActual)

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

出力引数:

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