IVssComponent::GetRestoreMetadata 方法 (vswriter.h)

GetRestoreMetadata 方法检索在 PreRestore 事件期间可能由 CVssWriter::OnPreRestore 使用 IVssComponent::SetRestoreMetadata 设置的特定于编写器的专用还原元数据。

只有编写器才能调用此方法。

语法

HRESULT GetRestoreMetadata(
  [out] BSTR *pbstrRestoreMetadata
);

参数

[out] pbstrRestoreMetadata

包含还原元数据的字符串。

返回值

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

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

注解

可以根据给定编写器的逻辑随时调用此方法。

调用方应通过调用 SysFreeString 释放 pbstrRestoreMetadata 参数保留的内存。

如果未设置备份元数据, GetBackupMetadata 将返回S_FALSE。

将还原方法设置为VSS_RME_RESTORE_TO_ALTERNATE_LOCATION而不定义备用位置映射的编写器将构成编写器错误。

要求

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

另请参阅

IVssComponent