iVssBackupComponentsEx2::SetRestoreName 方法 (vsbackup.h)

将新的逻辑名称分配给正在还原的组件。

语法

HRESULT SetRestoreName(
  [in] VSS_ID             writerId,
  [in] VSS_COMPONENT_TYPE ct,
  [in] LPCWSTR            wszLogicalPath,
  [in] LPCWSTR            wszComponentName,
  [in] LPCWSTR            wszRestoreName
);

参数

[in] writerId

编写器类的全局唯一标识符 (GUID) 。

[in] ct

组件的类型。 有关可能的值,请参阅 VSS_COMPONENT_TYPE 枚举。

[in] wszLogicalPath

包含组件的逻辑路径的 以 null 结尾的宽字符串。 有关详细信息,请参阅 组件的逻辑路径

包含此处使用的逻辑路径的字符串的值应与添加组件时使用的字符串相同。

逻辑路径可以为 NULL

对于可以出现在非 NULL 逻辑路径中的字符没有限制。

[in] wszComponentName

包含组件名称的 以 null 结尾的宽字符串。

字符串不能为 NULL ,并且应包含与使用 IVssBackupComponents::AddComponent 方法将组件添加到备份集时使用的组件名称相同的组件名称。

[in] wszRestoreName

一个 以 null 结尾的宽字符串,其中包含要为组件设置的还原名称。

返回值

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

含义
S_OK
已成功设置还原名称。
E_INVALIDARG
其中一个参数值无效。
E_OUTOFMEMORY
调用方内存或其他系统资源不足。
VSS_E_BAD_STATE
还原操作期间未调用此方法。
VSS_E_OBJECT_NOT_FOUND
找不到指定的组件。
VSS_E_UNEXPECTED
意外错误。 错误代码记录在错误日志文件中。 有关详细信息,请参阅 VSS 下的事件和错误处理

Windows Server 2008、Windows Vista、Windows Server 2003 和 Windows XP: 在 Windows Server 2008 R2 和 Windows 7 之前不支持此值。 改用E_UNEXPECTED。

注解

只能在还原操作期间调用 SetRestoreName 方法。

编写器通过在其备份架构掩码中设置 VSS_BS_RESTORE_RENAME 标志来指示它支持此方法。

有关详细信息,请参阅 设置 VSS 还原选项

要求

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

另请参阅

IVssBackupComponentsEx2

IVssComponentEx::GetRestoreName

VSS_BACKUP_SCHEMA