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

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

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

BackupComplete (CVssWriter::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::OnPostSnapshotPostSnapshot イベントを処理しているときに SetBackupStamp を呼び出します。

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

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

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

要件

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

こちらもご覧ください

IVssComponent

IVssComponent::GetBackupStamp