IVssComponentEx::GetRestoreName 方法 (vswriter.h)

获取分配给正在还原的组件的逻辑名称。

语法

HRESULT GetRestoreName(
  [out] BSTR *pbstrName
);

参数

[out] pbstrName

调用方分配的变量的地址,该变量接收包含组件的还原名称的以 null 结尾的宽字符串。

返回值

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

含义
S_OK
操作成功。
E_INVALIDARG
其中一个参数值无效。
E_OUTOFMEMORY
调用方内存或其他系统资源不足。

注解

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

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

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

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

要求

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

另请参阅

IVssBackupComponentsEx2::SetRestoreName

IVssComponentEx

VSS_BACKUP_SCHEMA