IVssComponent::GetPreRestoreFailureMsg 方法 (vswriter.h)

如果 IVssComponent::SetPreRestoreFailureMsg 设置了一个,则 GetPreRestoreFailureMsg 方法检索编写器在处理 PreRestore 事件时生成的错误消息。

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

语法

HRESULT GetPreRestoreFailureMsg(
  [out] BSTR *pbstrPreRestoreFailureMsg
);

参数

[out] pbstrPreRestoreFailureMsg

包含失败消息的字符串,该消息描述在处理 PreRestore 事件时发生的错误。

返回值

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

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

注解

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

如果未使用 SetPreRestoreFailureMsg 设置 PreRestore 失败消息, GetPreRestoreFailureMsg 将返回S_FALSE。

要求

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

另请参阅

IVssComponent

IVssComponent::GetPostRestoreFailureMsg

IVssComponent::SetPostRestoreFailureMsg

IVssComponent::SetPreRestoreFailureMsg