JetTruncateLogInstance 関数

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

適用対象: Windows |Windows Server

JetTruncateLogInstance 関数

JetTruncateLogInstance 関数は、現在のバックアップが正常に完了すると不要になったトランザクションログファイルを削除するために、JetBeginExternalBackup によって開始されたバックアップ中に使用されます。

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

    JET_ERR JET_API JetTruncateLogInstance(
      __in          JET_INSTANCE instance
    );

パラメーター

instance

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

Windows 2000 では、1 つのインスタンスのみがサポートされているため、このパラメーターを受け入れる API バリアントは使用できません。この場合、この 1 つのグローバルインスタンスの使用が暗黙的に示されます。

Windows XP 以降のリリースでは、このパラメーターを受け入れない API バリアントは、1 つのインスタンスのみがサポートされているレガシモード (Windows 2000 互換モード) の場合にのみ呼び出すことができます。それ以外の場合、操作はJET_errRunningInMultiInstanceModeで失敗します。

戻り値

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

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

この関数が成功すると、現在のバックアップが正常に完了すると不要になったトランザクションログファイルのセットが削除されます。データベースファイルのバックアップが許可されなくなっているよう、バックアップステートマシンが高度になります。この時点を超えてバックアップ用にデータベースパッチファイルとトランザクションログファイルのみを開くことができます。

この関数が失敗した場合は、データベースファイルのバックアップが許可されなくなっているよう、バックアップステートマシンを拡張できます。一部のトランザクションログファイルは、必要な数より少ない数だけ削除される場合がありますが、常に古いものから最年少のファイルに削除されます。

必要条件

要件	値
Client	Windows Vista または Windows XP が必要です。
[サーバー]	Windows Server 2008 または Windows Server 2003 が必要です。
Header	Esent.h で宣言されています。
Library	ESENT.lib を使用します。
[DLL]	ESENT.dllが必要です。

参照

拡張可能なストレージエンジンファイル
 JET_ERR
JET_INSTANCE
JetBeginExternalBackup
JetOpenFile
JetStopBackup
JetStopService

次の方法で共有

JetTruncateLogInstance 関数