IVssComponent::GetBackupSucceeded メソッド (vswriter.h)

GetBackupSucceeded メソッドは、選択したコンポーネントまたはコンポーネント セットのすべてのファイルをVSS_FILE_RESTORE_STATUS列挙としてバックアップしようとした場合の完全な試行の状態を返します。 (コンポーネント の選択については、「選択可能性と論理パスの操作 」を参照してください)。

ライターまたはリクエスターは、このメソッドを呼び出すことができます。

構文

HRESULT GetBackupSucceeded(
  [out] bool *pbSucceeded
);

パラメーター

[out] pbSucceeded

バックアップが成功した場合は true 、それ以外の場合は false を受け取る呼び出し元割り当て変数のアドレス。

戻り値

このメソッドの有効なリターン コードを次に示します。

説明
S_OK
属性値が正常に返されました。
S_FALSE
BackupComplete イベントの前に メソッドが呼び出されたため、バックアップの成功状態は未定義です。
E_INVALIDARG
パラメーター値の 1 つが無効です。
E_OUTOFMEMORY
呼び出し元がメモリやその他のシステム リソースを使い切れている。
VSS_E_INVALID_XML_DOCUMENT
XML ドキュメントが無効です。 詳細については、イベント ログを確認してください。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。

解説

このメソッドは BackupComplete イベントの前に呼び出すべきではありません。イベント ハンドラー CVssWriter::OnBackupComplete の実装で使用するように設計されています。

要件

   
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー vswriter.h (Vss.h、VsWriter.h を含む)
Library VssApi.lib

関連項目

CVssWriter::OnBackupComplete

IVssComponent