IVssBackupComponents::SetBackupSucceeded メソッド (vsbackup.h)

  • [アーティクル]

SetBackupSucceeded メソッドは、特定のライターの指定されたコンポーネントのバックアップが成功したかどうかを示します。

構文

HRESULT SetBackupSucceeded(
  [in] VSS_ID             instanceId,
  [in] VSS_ID             writerId,
  [in] VSS_COMPONENT_TYPE ct,
  [in] LPCWSTR            wszLogicalPath,
  [in] LPCWSTR            wszComponentName,
  [in] bool               bSucceded
);

パラメーター

[in] instanceId

ライター インスタンスのグローバル一意識別子 (GUID)。

[in] writerId

ライター クラスのグローバル一意識別子 (GUID)。

[in] ct

コンポーネントの種類。 使用可能 な 値については、「VSS_COMPONENT_TYPE」を参照してください。

[in] wszLogicalPath

コンポーネントの論理パスを含む Null で終わるワイド文字列。

詳細については、「 コンポーネントの論理パス」を参照してください。

ここで使用する論理パスを含む文字列の値は、 コンポーネントが IVssBackupComponents::AddComponents を使用してバックアップ セットに追加されたときに使用されたものと同じである必要があります。

論理パスには NULL を指定できます。

NULL 以外の論理パスに出現できる文字に制限はありません。

[in] wszComponentName

コンポーネントの名前を含む Null で終わるワイド文字列。

文字列を NULL にすることはできません。また、 コンポーネントが IVssBackupComponents::AddComponent を使用してバックアップ セットに追加されたときに使用されたものと同じコンポーネント名を含める必要があります。

[in] bSucceded

コンポーネントが正常にバックアップされた場合は true 、それ以外の場合は false に設定します。

戻り値

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

値 説明
S_OK
 バックアップに成功した状態を正常に設定しました。
E_INVALIDARG
 パラメーター値の 1 つが無効です。
E_OUTOFMEMORY
 呼び出し元がメモリやその他のシステム リソースを使い切れている。
VSS_E_BAD_STATE
 バックアップ コンポーネント オブジェクトが初期化されていないか、復元操作中にこのメソッドが呼び出されたか、このメソッドが正しいシーケンス内で呼び出されていません。
VSS_E_OBJECT_NOT_FOUND
 バックアップ コンポーネントが存在しません。
VSS_E_INVALID_XML_DOCUMENT
 XML ドキュメントが無効です。 詳細については、イベント ログを確認してください。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。
VSS_E_UNEXPECTED
 予期しないエラー。 エラー コードは、エラー ログ ファイルに記録されます。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。

Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP: この値は、Windows Server 2008 R2 と Windows 7 まではサポートされません。 代わりに E_UNEXPECTED が使用されます。

解説

コンポーネント モードで作業する場合 (select components 引数を true に設定して IVssBackupComponents::SetBackupState が呼び出されると)、ライターは IVssComponent::GetBackupSucceeded を使用して各コンポーネントのバックアップの状態をチェックします。 したがって、適切に動作するバックアップ アプリケーション (リクエスター) は、各コンポーネントが処理された後、および IVssBackupComponents::BackupComplete を呼び出す前に SetBackupSucceeded を呼び出す必要があります。

IVssBackupComponents::D oSnapshotSet の呼び出しに失敗した場合は、このメソッドを呼び出さないでください。 要求者がバックアップ操作で DoSnapshotSet、 SetBackupSucceeded、 BackupComplete を使用する方法の詳細については、「 バックアップ前タスクの概要 」および「 ファイルの実際のバックアップの概要」を参照してください。

要件

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

関連項目

IVssBackupComponents

IVssBackupComponents::BackupComplete

IVssBackupComponents::SetBackupState

VSS_COMPONENT_TYPE