IVssComponent::SetBackupStamp 方法 (vswriter.h)

SetBackupStamp 方法设置一个字符串,其中包含指示备份时间的信息。

编写器只能在备份操作期间调用此方法。

处理 BackupComplete (CVssWriter::OnBackupComplete) 或 BackupShutdown (CVssWriter::OnBackupShutdown) 事件时,无法调用此方法。

语法

HRESULT SetBackupStamp(
  [in] LPCWSTR wszBackupStamp
);

参数

[in] wszBackupStamp

以 Null 结尾的宽字符串信息,指示何时进行备份。

返回值

下面是此方法的有效返回代码。

含义
S_OK
已成功设置备份时间戳。
E_INVALIDARG
其中一个参数值无效。
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

另请参阅

IVssComponent

IVssComponent::GetBackupStamp