GetRestoreMetadata メソッドは、IVssComponent::SetRestoreMetadata を使用して、CVssWriter::OnPreRestore によって PreRestore イベント中に設定された可能性がある、ライター固有のプライベートな復元メタデータを取得します。
このメソッドを呼び出すことができるのはライターだけです。
構文
HRESULT GetRestoreMetadata(
[out] BSTR *pbstrRestoreMetadata
);
パラメーター
[out] pbstrRestoreMetadata
復元メタデータを含む文字列。
戻り値
このメソッドの有効なリターン コードを次に示します。
| 値 | 説明 |
|---|---|
|
属性値が正常に返されました。 |
|
指定した属性に値がありません。 |
|
パラメーター値の 1 つが無効です。 |
|
呼び出し元がメモリ不足またはその他のシステム リソースです。 |
|
XML ドキュメントが無効です。 詳細については、イベント ログを確認してください。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。 |
解説
このメソッドは、特定のライターのロジックに応じて、いつでも呼び出すことができます。
呼び出し元は、SysFreeString を呼び出して pbstrRestoreMetadata パラメーターによって保持されているメモリを解放する必要があります。
バックアップ メタデータが設定されていない場合、 GetBackupMetadata はS_FALSEを返します。
代替ロケーション・マッピングを定義せずに復元メソッドをVSS_RME_RESTORE_TO_ALTERNATE_LOCATIONに設定したライターは、ライター・エラーを構成します。
要件
| サポートされている最小のクライアント | Windows XP (デスクトップ アプリのみ) |
| サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
| 対象プラットフォーム | Windows |
| ヘッダー | vswriter.h (Vss.h、VsWriter.h を含む) |
| Library | VssApi.lib |