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

  • [アーティクル]

SetRestoreOptions メソッドは、ライター コンポーネントのプライベートまたはライターに依存する復元パラメーターの文字列を設定します。

構文

HRESULT SetRestoreOptions(
  [in] VSS_ID             writerId,
  [in] VSS_COMPONENT_TYPE ct,
  [in] LPCWSTR            wszLogicalPath,
  [in] LPCWSTR            wszComponentName,
  [in] LPCWSTR            wszRestoreOptions
);

パラメーター

[in] writerId

ライター識別子。

[in] ct

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

[in] wszLogicalPath

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

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

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

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

[in] wszComponentName

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

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

[in] wszRestoreOptions

復元パラメーターのプライベート文字列を含む Null で終わるワイド文字列。 詳細については、「 VSS 復元オプションの設定」を参照してください。

戻り値

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

値 説明
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が使用されます。

解説

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

SetRestoreOptions メソッドの wszRestoreOptions パラメーターによって設定される復元オプションの正確な構文と内容は、接続されている特定のライターによって異なります。

要件

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

関連項目

IVssBackupComponents

IVssBackupComponents::P reRestore

VSS_COMPONENT_TYPE