IVssBackupComponentsEx2::SetRestoreName メソッド (vsbackup.h)

  • [アーティクル]

復元するコンポーネントに新しい論理名を割り当てます。

構文

HRESULT SetRestoreName(
  [in] VSS_ID             writerId,
  [in] VSS_COMPONENT_TYPE ct,
  [in] LPCWSTR            wszLogicalPath,
  [in] LPCWSTR            wszComponentName,
  [in] LPCWSTR            wszRestoreName
);

パラメーター

[in] writerId

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

[in] ct

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

[in] wszLogicalPath

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

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

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

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

[in] wszComponentName

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

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

[in] wszRestoreName

コンポーネントに設定する復元名を含む null で終わるワイド文字列。

戻り値

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

値 意味
S_OK
 復元名が正常に設定されました。
E_INVALIDARG
 パラメーター値の 1 つが無効です。
E_OUTOFMEMORY
 呼び出し元がメモリやその他のシステム リソースを使い切れている。
VSS_E_BAD_STATE
 このメソッドは、復元操作中に呼び出されませんでした。
VSS_E_OBJECT_NOT_FOUND
 指定されたコンポーネントが見つかりませんでした。
VSS_E_UNEXPECTED
 予期しないエラー。 エラー コードは、エラー ログ ファイルに記録されます。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。

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

注釈

SetRestoreName メソッドは、復元操作中にのみ呼び出すことができます。

ライターは、バックアップ スキーマ マスクに VSS_BS_RESTORE_RENAME フラグを設定することで、このメソッドをサポートしていることを示します。

詳細については、「 VSS 復元オプションの設定」を参照してください。

要件

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

こちらもご覧ください

IVssBackupComponentsEx2

IVssComponentEx::GetRestoreName

VSS_BACKUP_SCHEMA