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

SetBackupStamp メソッドは、バックアップがいつ行われたかを示す情報を含む文字列を設定します。

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

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

構文

HRESULT SetBackupStamp(
  [in] LPCWSTR wszBackupStamp
);

[in] wszBackupStamp

バックアップがいつ行われたかを示す Null で終わるワイド文字列情報。

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

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

バックアップスタンプの詳細については、「複合ストアのバックアップにおけるライターロール」を参照してください。

SetBackupStamp によって設定されたバックアップスタンプは、コンポーネント内のすべてのファイルと、コンポーネントに含まれる選択できないサブコンポーネントに適用されます。

ライターは通常、CVssWriter::OnPostSnapshot で PostSnapshot イベントを処理するときに SetBackupStamp を呼び出します。

要求者は、バックアップスタンプをバックアップコンポーネントドキュメントに格納するだけです。バックアップスタンプを直接使用したり、それを解釈する方法を知る必要はありません。

リクエスターが復元操作中に行うバックアップスタンプの唯一の用途は、 IVssBackupComponents::SetPreviousBackupStamp メソッドを使用して、格納されているタイムスタンプ文字列をライターが使用できるようにすることです。

このため、バックアップスタンプの内容に形式の制限はありません。これには、時刻と日付の情報、論理シーケンス番号、または同じクラスのライターが最後のバックアップがいつ行われたかを判断できるその他の情報が含まれている場合があります。

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