JetStopBackupInstance 関数

適用対象: Windows |Windows Server

JetStopBackupInstance 関数

JetStopBackupInstance 関数を使用すると、ストリーミング バックアップ関連のアクティビティが特定の実行中のインスタンスで続行されなくなり、ストリーミング バックアップが予測可能な方法で終了します。

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

    JET_ERR JET_API JetStopBackupInstance(
      __in          JET_INSTANCE instance
    );

パラメーター

instance

API 呼び出しに使用する実行中のインスタンスを識別します。

戻り値

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

リターン コード	説明
JET_errSuccess	操作は正常に完了しました。
JET_errInvalidParameter	指定されたインスタンス パラメーターの値が無効です (現在実行中のインスタンスではありません)。 Windows XP: この戻り値は Windows XP で導入されています。

この関数が成功すると、指定されたインスタンスが新しいストリーミング バックアップ API の失敗を開始します。

この関数が失敗した場合、インスタンスのバックアップ終了を準備する手順は実行されません。また、インスタンスの状態に対する変更は行われません。

解説

バックアップは通常、プロセス メカニズムの外部のイベントによってトリガーされ、この API を使用すると、ESENT アプリケーション自体がストリーミング バックアップ API をさらに呼び出して失敗します。 ストリーミング バックアップ API の大部分は、JET_errBackupAbortByServerで失敗し始めます。 そのため、ストリーミング バックアップの進行状況 ( JetReadFileInstance など) はエラーを返します。 バックアップ終了の一部であるバックアップ操作 ( JetEndExternalBackupInstance など) は引き続き許可されます。

必要条件

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

参照

JET_ERR
JET_INSTANCE
JetEndExternalBackupInstance
JetReadFileInstance
JetStopService