JetGetTruncateLogInfoInstance 関数

[アーティクル]
06/13/2023

適用対象: Windows |Windows Server

JetGetTruncateLogInfoInstance 関数

JetGetTruncateLogInfoInstance 関数は、JetBeginExternalBackup によって開始されるバックアップ中に使用され、バックアップが正常に完了した後に安全に削除できるトランザクションログファイルの名前をインスタンスに照会します。

Windows XP:JetGetTruncateLogInfoInstance は Windows XP で導入されています。

    JET_ERR JET_API JetGetTruncateLogInfoInstance(
      __in          JET_INSTANCE instance,
      __out_opt     tchar* szz,
      __in          unsigned long cbMax,
      __out_opt     unsigned long* pcbActual
    );

パラメーター

instance

この呼び出しに使用するインスタンス。

Szz

バックアップが正常に完了した後に安全に削除できるトランザクションログファイルのセットを記述する null で終わる文字列の一覧を受け取る出力バッファー。

このバッファーで返される文字列の一覧は、レジストリで使用される複数文字列と同じ形式です。 null で終わる各文字列は順番に返され、その後に最終的な null ターミネータが続きます。

cbMax

出力バッファーの最大サイズ (バイト単位)。

pcbActual

文字列データの実際の量を受け取る出力バッファーへのポインター。

戻り値

この関数は、次のいずれかのリターンコードを使用して、JET_ERR データ型を返します。考えられる ESE エラーの詳細については、「拡張可能ストレージエンジンエラー」および「エラー処理パラメーター」を参照してください。

リターンコード	説明
JET_errSuccess	操作は正常に完了しました。
JET_errInvalidParameter	指定されたパラメーターの 1 つに予期しない値が含まれていたか、複数のパラメーター値の組み合わせによって予期しない結果が発生しました。 Windows XP 以降: これは、指定されたインスタンスハンドルが無効な場合に JetGetTruncateLogInfoInstance で発生する可能性があります。
JET_errNotInitialized	セッションに関連付けられているインスタンスがまだ初期化されていないため、操作を完了できません。
JET_errClientRequestToStopJetService	JetStopService の呼び出しの結果、セッションに関連付けられているインスタンス上のすべてのアクティビティが停止したため、操作を完了できません。
JET_errInstanceUnavailable	セッションに関連付けられているインスタンスで致命的なエラーが発生したため、操作を完了できません。このエラーでは、そのデータの整合性を保護するためにすべてのデータへのアクセスを取り消す必要があります。 Windows XP: この戻り値は Windows XP で導入されました。
JET_errBackupAbortByServer	JetStopBackup の呼び出しによって現在の外部バックアップが中止されたため、操作は失敗しました。 Windows XP: この戻り値は Windows XP で導入されました。
JET_errInvalidBackupSequence	バックアップ操作が順番に呼び出されたため、失敗しました。
JET_errNoBackup	外部バックアップが進行中でないため、操作は失敗しました。
JET_errRestoreInProgress	セッションに関連付けられているインスタンスで復元操作が進行中のため、操作を完了できません。
JET_errTermInProgress	セッションに関連付けられているインスタンスがシャットダウンされているため、操作を完了できません。
JetGetTruncateLogInfoInstance	インスタンスに JetOpenFile を使用して作成された未処理のファイルハンドルがあります。

この関数が成功した場合、バックアップが正常に完了した後に安全に削除できるトランザクションログファイルのセットに関する要求された情報は、指定された出力バッファーに配置されます。データベースファイルのバックアップが許可されないように、バックアップステートマシンが高度になります。この時点を超えてバックアップのために開くことができるのは、データベースパッチファイルとトランザクションログファイルだけです。

この関数が失敗した場合、出力バッファーの状態は未定義です。エラーが発生すると、インスタンスのバックアッププロセス全体が取り消されます。

解説

出力バッファーが小さすぎて、バックアップファイルセットの一部である必要があるファイルの完全な一覧を受け入れられない場合、この API はエラーまたは警告を返しません。アプリケーションは常に、このリストの実際のサイズを受け取るバッファーを提供し、その情報を使用してリストが切り捨てられたかどうかを判断する必要があります。

必要条件

要件	値
Client	Windows Vista または Windows XP が必要です。
[サーバー]	Windows Server 2008 または Windows Server 2003 が必要です。
Header	Esent.h で宣言されています。
Library	ESENT.lib を使用します。
[DLL]	ESENT.dllが必要です。
Unicode	JetGetTruncateLogInfoInstanceW (Unicode) および JetGetTruncateLogInfoInstanceA (ANSI) として実装されます。

参照

JET_ERR
JET_INSTANCE
JetBeginExternalBackup
JetCloseDatabase
JetCloseTable
JetEndSession
JetOpenFile
JetResetSessionContext
JetRollback
JetStopBackup
JetStopService
JetTerm
JetTerm2

次の方法で共有

JetGetTruncateLogInfoInstance 関数