IVssComponentEx::SetPrepareForBackupFailureMsg 方法 (vswriter.h)

为组件设置 PrepareForBackup 失败消息字符串。

此方法只能由编写器的 CVssWriter::OnPrepareBackup 方法调用。

语法

HRESULT SetPrepareForBackupFailureMsg(
  [in] LPCWSTR wszFailureMsg
);

参数

[in] wszFailureMsg

调用方分配的 以 NULL 结尾的宽字符串的地址,其中包含描述处理 PrepareForBackup 事件时发生的错误的失败消息。

返回值

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

含义
S_OK
已成功设置失败消息。
E_INVALIDARG
其中一个参数值无效。
E_OUTOFMEMORY
调用方内存或其他系统资源不足。
VSS_E_BAD_STATE
编写器的 CVssWriter::OnPrepareBackup 方法未调用此方法。

注解

SetPrepareForBackupFailureMsg 设置的失败消息适用于组件中的所有文件和任何子组件。

要求

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

另请参阅

CVssWriter::OnPrepareBackup

IVssComponentEx

IVssComponentEx::GetPrepareForBackupFailureMsg