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