IVssComponent::GetBackupStamp 方法 (vswriter.h)

GetBackupStamp 方法返回由编写器为给定组件存储的备份标记字符串。

编写器或请求者都可以调用此方法。

语法

HRESULT GetBackupStamp(
  [out] BSTR *pbstrBackupStamp
);

参数

[out] pbstrBackupStamp

调用方分配的变量的地址,该变量接收一个字符串,其中包含指示备份组件的时间的备份标记。

返回值

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

含义
S_OK
已成功返回属性值。
S_FALSE
没有与此组件关联的时间戳。
E_INVALIDARG
其中一个参数值无效。
E_OUTOFMEMORY
调用方内存不足或其他系统资源。
VSS_E_INVALID_XML_DOCUMENT
XML 文档无效。 有关详细信息,请查看事件日志。 有关详细信息,请参阅 VSS 下的事件和错误处理

注解

如果未设置备份时间戳, GetBackupStamp 将返回S_FALSE。

如果调用 GetBackupStamp 成功,则调用方负责通过调用 SysFreeString 函数释放 pbstrBackupStamp 参数中返回的字符串。

返回的字符串引用组件中的所有文件及其具有的任何不可选择的子组件。

GetBackupStamp 检索到的备份标记通常由编写器通过从 PostSnapshot 事件处理程序 CVssWriter::OnPostSnapshot 中调用 IVssComponent::SetBackupStamp 来设置。

请求者仅将备份标记存储在备份组件文档中;他们不直接使用备份标记,不知道如何生成它,也不了解其格式。

要求

   
最低受支持的客户端 Windows XP [仅限桌面应用]
最低受支持的服务器 Windows Server 2003 [仅限桌面应用]
目标平台 Windows
标头 vswriter.h (包括 Vss.h、VsWriter.h)
Library VssApi.lib

另请参阅

IVssBackupComponents::SetPreviousBackupStamp

IVssComponent

IVssComponent::SetBackupStamp