IVssComponent::SetBackupMetadata メソッド (vswriter.h)

SetBackupMetadata メソッドは、コンポーネントを使用してバックアップ メタデータを設定します。

ライターは、バックアップ操作中にのみこのメソッドを呼び出すことができます。

BackupComplete (CSVsWriter::OnBackupComplete) イベントまたは BackupShutdown (CVssWriter::OnBackupShutdown) イベントの処理中に、このメソッドを呼び出すことはできません。

構文

HRESULT SetBackupMetadata(
  [in] LPCWSTR wszData
);

パラメーター

[in] wszData

バックアップ メタデータを含む NULL で終わるワイド文字列。

戻り値

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

説明
S_OK
アイテムを正常に設定しました。
E_INVALIDARG
パラメーター値の 1 つが無効です。
E_OUTOFMEMORY
呼び出し元がメモリやその他のシステム リソースを使い切れている。
VSS_E_OBJECT_ALREADY_EXISTS
プライベート メタデータは、このコンポーネント用に既に書き込まれています。
VSS_E_BAD_STATE
このメソッドはライターによって呼び出されなかったか、ライターによって呼び出された場合は、バックアップ操作中に呼び出されなかったか、BackupComplete または BackupShutdown イベントの処理中に呼び出されました。

解説

SetBackupMetadata は、バックアップ操作を記述するライター固有のプライベート メタデータを設定します。

この形式は、VSS メタデータ仕様に準拠している必要はありません。

要件

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

関連項目

IVssComponent

IVssComponent::GetBackupMetadata

IVssComponent::SetRestoreMetadata