FhServiceStartBackup 関数 (fhsvcctl.h)

この関数は、現在のユーザーの即時バックアップを開始します。

注意

FhServiceStartBackup は非推奨であり、今後のリリースでは変更または使用できない可能性があります。

構文

HRESULT FhServiceStartBackup(
  [in] FH_SERVICE_PIPE_HANDLE Pipe,
  [in] BOOL                   LowPriorityIo
);

パラメーター

[in] Pipe

以前の FhServiceOpenPipe 呼び出しによって返された通信チャネル ハンドル。

[in] LowPriorityIo

TRUE の場合、ファイル履歴サービスは、この関数によってスケジュールされた即時バックアップに優先順位の低い I/O を使用するように指示されます。 優先度の低い I/O により、フォアグラウンド ユーザー アクティビティへの影響が軽減されます。 このパラメーターを TRUE に設定することをお勧めします 。

FALSE の場合、ファイル履歴サービスは、この関数によってスケジュールされた即時バックアップに通常の優先度 I/O を使用するように指示されます。 これにより、バックアップが高速になりますが、ユーザー アプリケーションの応答性とパフォーマンスに悪影響を及ぼします。

戻り値

成功した場合はS_OK 、失敗した場合は 失敗した HRESULT 。 失敗した 可能性のある HRESULT 値には、FhErrors.h ヘッダー ファイルで定義されている値が含まれます。

解説

この関数は、即時バックアップが完了するまで待機しません。 バックアップ中にエラーまたは警告条件が発生した場合、アクション センター通知を介してユーザーに通知され、 プログラムで IFhConfigMgr::QueryProtectionStatus メソッドを使用して取得できます。

この関数を呼び出すことによって開始されるバックアップ サイクルは、 FhServiceStopBackup 関数を使用して停止できます。

要件

サポートされている最小のクライアント	Windows 8 [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2012 [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	fhsvcctl.h
Library	FhSvcCtl.lib

関連項目

FhServiceOpenPipe

FhServiceStopBackup

IFhConfigMgr::QueryProtectionStatus