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

  • [アーティクル]

SetRangesFilePath メソッドは、部分ファイル操作で範囲ファイルが必要であり、そのファイルが元のファイル以外の場所に復元された場合に使用されます。

構文

HRESULT SetRangesFilePath(
  [in] VSS_ID             writerId,
  [in] VSS_COMPONENT_TYPE ct,
  [in] LPCWSTR            wszLogicalPath,
  [in] LPCWSTR            wszComponentName,
  [in] UINT               iPartialFile,
  [in] LPCWSTR            wszRangesFile
);

パラメーター

[in] writerId

部分ファイル操作に関連するファイルを含むライター クラスのグローバル一意識別子 (GUID)。

[in] ct

コンポーネントの種類を識別します。 可能な戻り値については、「 VSS_COMPONENT_TYPE 」を参照してください。

[in] wszLogicalPath

部分ファイル操作に参加しているファイルを含むコンポーネントの論理パスを含む Null で終わるワイド文字列。

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

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

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

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

[in] wszComponentName

部分ファイル操作に参加しているファイルを含むコンポーネントの名前を含む Null で終わるワイド文字列。

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

[in] iPartialFile

部分ファイルのインデックス番号。 このパラメーターの値は、0 から n から 1 までの整数です。 n は、特定のコンポーネントに関連付けられている部分ファイルの合計数です。 n の値は、IVssComponent::GetPartialFileCount によって返されます。

[in] wszRangesFile

範囲ファイルの完全修飾パスを含む Null で終わるワイド文字列。

戻り値

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

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

解説

範囲ファイルを復元する場合、 SetRangesFilePath を呼び出す必要はありません。

要件

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

関連項目

IVssBackupComponents

IVssComponent::AddPartialFile

IVssComponent::GetPartialFile

IVssComponent::GetPartialFileCount