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

  • [アーティクル]

SetSelectedForRestore メソッドは、指定した選択可能なコンポーネントが復元用に選択されているかどうかを示します。

構文

HRESULT SetSelectedForRestore(
  [in] VSS_ID             writerId,
  [in] VSS_COMPONENT_TYPE ct,
  [in] LPCWSTR            wszLogicalPath,
  [in] LPCWSTR            wszComponentName,
  [in] bool               bSelectedForRestore
);

パラメーター

[in] writerId

ライター識別子。

[in] ct

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

[in] wszLogicalPath

コンポーネントの論理パスを含む Null で終わるワイド文字列。 詳細については、「 コンポーネントの論理パス」を参照してください。

ここで使用する論理パスを含む文字列の値は、コンポーネントの追加時に使用されたものと同じである必要があります。

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

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

[in] wszComponentName

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

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

[in] bSelectedForRestore

このパラメーターの値が 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が使用されます。

注釈

SetSelectedForRestore は、コンポーネント モードで行われる復元に対してのみ意味があります。

SetSelectedForRestore は、 IVssBackupComponents::AddComponent を使用して、バックアップ時にバックアップ ドキュメントに明示的に追加されたコンポーネントに対してのみ呼び出すことができます。 コンポーネント セットの一部としてバックアップ用に暗黙的に選択されたコンポーネントの復元は、ドキュメントに追加された最も近い先祖コンポーネントで SetSelectedForRestore を呼び出すことによって行う必要があります。 このコンポーネントのデータのみを復元する場合は、 IVssBackupComponents::AddRestoreSubcomponent を使用して行う必要があります。これは、コンポーネントが復元可能な場合にのみ実行できます ( 「選択性と論理パスの操作」を参照)。

このメソッドは、 IVssBackupComponents::P reRestore の前に呼び出す必要があります。

要件

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

こちらもご覧ください

IVssBackupComponents

IVssBackupComponents::P reRestore

IVssComponent::IsSelectedForRestore

VSS_COMPONENT_TYPE