IVssComponent::GetBackupMetadata メソッド (vswriter.h)
GetBackupMetadata メソッドは、IVssComponent::SetBackupMetadata を使用して、CVssWriter::OnPrepareBackup による PrepareForBackup イベント中に設定された可能性がある、ライター固有のプライベート バックアップ メタデータを取得します。
ライターのみがこのメソッドを呼び出すことができます。
構文
HRESULT GetBackupMetadata(
[out] BSTR *pbstrData
);
パラメーター
[out] pbstrData
OnPrepareBackup イベント中に追加されたバックアップ メタデータを含む文字列を受け取る呼び出し元割り当て変数のアドレス。
戻り値
このメソッドの有効なリターン コードを次に示します。
| 値 | 意味 |
|---|---|
|
属性値が正常に返されました。 |
|
このコンポーネントに関連付けられているバックアップ メタデータはありません。 |
|
パラメーター値の 1 つが無効です。 |
|
呼び出し元がメモリやその他のシステム リソースを使い切れている。 |
|
XML ドキュメントが無効です。 詳細については、イベント ログを確認してください。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。 |
注釈
このメソッドは、特定のライターのロジックに応じて、いつでも呼び出すことができます。
バックアップ メタデータが設定されていない場合、 GetBackupMetadata はS_FALSEを返します。
GetBackupMetadata の呼び出しが成功した場合、呼び出し元は SysFreeString 関数を呼び出すことによって pbstrMetadata パラメーターで返される文字列を解放します。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows XP (デスクトップ アプリのみ) |
| サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
| 対象プラットフォーム | Windows |
| ヘッダー | vswriter.h (Vss.h、VsWriter.h を含む) |
| Library | VssApi.lib |