ホーム › Storage.Jet › JetGetLogInfoInstance2W

JetGetLogInfoInstance2W

関数

ログ情報構造体付きでバックアップ対象ログ一覧を取得する(Unicode版)。

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

シグネチャ

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

INT JetGetLogInfoInstance2W(
    JET_INSTANCE instance,
    WORD* wszzLogs,   // optional
    DWORD cbMax,
    DWORD* pcbActual,   // optional
    JET_LOGINFO_W* pLogInfo   // optional
);

パラメーター

名前	型	方向	説明
instance	JET_INSTANCE	in	情報取得対象のインスタンスを識別するJET_INSTANCEハンドル。
wszzLogs	WORD*	outoptional	バックアップ対象のログファイル一覧を受け取る出力Unicode文字列バッファポインタ。NUL区切りの多重文字列となる。
cbMax	DWORD	in	wszzLogsバッファのサイズをバイト単位で指定する値。
pcbActual	DWORD*	outoptional	実際に必要/書き込まれたバイト数を受け取る出力ポインタ。
pLogInfo	JET_LOGINFO_W*	inoutoptional	ログ世代の範囲などの追加情報を受け取るJET_LOGINFO_W構造体ポインタ。NULL可。

戻り値の型: INT

公式ドキュメント

JetGetLogInfoInstance2 関数は、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 Server 2008 または Windows Server 2003 が必要です。
ヘッダー	Esent.h で宣言されています。
ライブラリ	ESENT.lib を使用します。
DLL	ESENT.dll が必要です。
Unicode	JetGetLogInfoInstance2W (Unicode) および JetGetLogInfoInstance2A (ANSI) として実装されています。

各言語での呼び出し定義

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

INT JetGetLogInfoInstance2W(
    JET_INSTANCE instance,
    WORD* wszzLogs,   // optional
    DWORD cbMax,
    DWORD* pcbActual,   // optional
    JET_LOGINFO_W* pLogInfo   // optional
);

[DllImport("ESENT.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int JetGetLogInfoInstance2W(
    UIntPtr instance,   // JET_INSTANCE
    IntPtr wszzLogs,   // WORD* optional, out
    uint cbMax,   // DWORD
    IntPtr pcbActual,   // DWORD* optional, out
    IntPtr pLogInfo   // JET_LOGINFO_W* optional, in/out
);

<DllImport("ESENT.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function JetGetLogInfoInstance2W(
    instance As UIntPtr,   ' JET_INSTANCE
    wszzLogs As IntPtr,   ' WORD* optional, out
    cbMax As UInteger,   ' DWORD
    pcbActual As IntPtr,   ' DWORD* optional, out
    pLogInfo As IntPtr   ' JET_LOGINFO_W* optional, in/out
) As Integer
End Function

' instance : JET_INSTANCE
' wszzLogs : WORD* optional, out
' cbMax : DWORD
' pcbActual : DWORD* optional, out
' pLogInfo : JET_LOGINFO_W* optional, in/out
Declare PtrSafe Function JetGetLogInfoInstance2W Lib "esent" ( _
    ByVal instance As LongPtr, _
    ByVal wszzLogs As LongPtr, _
    ByVal cbMax As Long, _
    ByVal pcbActual As LongPtr, _
    ByVal pLogInfo 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

JetGetLogInfoInstance2W = ctypes.windll.esent.JetGetLogInfoInstance2W
JetGetLogInfoInstance2W.restype = ctypes.c_int
JetGetLogInfoInstance2W.argtypes = [
    ctypes.c_size_t,  # instance : JET_INSTANCE
    ctypes.POINTER(ctypes.c_ushort),  # wszzLogs : WORD* optional, out
    wintypes.DWORD,  # cbMax : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbActual : DWORD* optional, out
    ctypes.c_void_p,  # pLogInfo : JET_LOGINFO_W* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetGetLogInfoInstance2W = Fiddle::Function.new(
  lib['JetGetLogInfoInstance2W'],
  [
    Fiddle::TYPE_UINTPTR_T,  # instance : JET_INSTANCE
    Fiddle::TYPE_VOIDP,  # wszzLogs : WORD* optional, out
    -Fiddle::TYPE_INT,  # cbMax : DWORD
    Fiddle::TYPE_VOIDP,  # pcbActual : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pLogInfo : JET_LOGINFO_W* optional, in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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