IVssExamineWriterMetadata::GetAlternateLocationMapping メソッド (vsbackup.h)

  • [アーティクル]

GetAlternateLocationMapping メソッドは、ファイル セットの特定の代替場所マッピングを取得します。

構文

HRESULT GetAlternateLocationMapping(
  [in]  UINT           iMapping,
  [out] IVssWMFiledesc **ppFiledesc
);

パラメーター

[in] iMapping

特定のマッピングのインデックス。 このパラメーターの値は、0 から n から 1 までの整数です。 n は、特定のライターに関連付けられた代替ロケーション マッピングの合計数です。 n の値は、IVssExamineWriterMetadata::GetRestoreMethod によって返されます。

[out] ppFiledesc

代替ロケーション マッピング情報を含む IVssWMFiledesc オブジェクトへの二重間接ポインター。

戻り値

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

値 説明
S_OK
 IVssWMFiledesc インターフェイスへのポインターが正常に返されました。
E_INVALIDARG
 パラメーター値の 1 つが無効です。
E_OUTOFMEMORY
 呼び出し元がメモリやその他のシステム リソースを使い切れている。
VSS_E_INVALID_XML_DOCUMENT
 XML ドキュメントが無効です。 詳細については、イベント ログを確認してください。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。
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 が使用されます。

解説

IVssExamineWriterMetadata::GetAlternateLocationMapping によって返される値は、IVssComponent::GetAlternateLocationMapping によって返される値と混同しないでください。

IVssComponent::GetAlternateLocationMapping は、ファイルが復元された別の場所です。

IVssExamineWriterMetadata::GetAlternateLocationMapping は、必要に応じてファイルを復元できる別の場所マッピングです。

次のいずれかが当てはまる場合は、常にファイルを別の場所マッピングに復元する必要があります。

  • 復元方法 (バックアップ時に設定) がVSS_RME_RESTORE_TO_ALTERNATE_LOCATION。
  • その復元ターゲットが (復元時に) VSS_RT_ALTERNATEに設定されました。
いずれの場合も、有効な代替ロケーション・マッピングが定義されていない場合、これはライター・エラーを構成します。

次のいずれかが当てはまる場合は、ファイルを別の場所マッピングに復元できます。

  • 復元方法はVSS_RME_RESTORE_IF_NOT_THEREであり、ファイルのバージョンは既にディスク上に存在します。
  • 復元方法がVSS_RME_RESTORE_IF_CAN_REPLACEされ、ファイルのバージョンがディスク上に存在し、置き換えることはできません。
ここでも、有効な代替場所マッピングが定義されていない場合、これはライター エラーを構成します。

代替の場所マッピングは復元操作中にのみ使用され、バックアップ操作中にのみ使用される代替パスと混同しないでください。

呼び出し元は、 IUnknown::Release を呼び出して、返された IVssWMFiledesc オブジェクトのリソースを解放します。

要件

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

関連項目

IVssBackupComponents::AddAlternativeLocationMapping

IVssComponent::GetAlternateLocationMapping

IVssExamineWriterMetadata

IVssExamineWriterMetadata::GetRestoreMethod

IVssWMFiledesc