IVssCreateWriterMetadata::AddAlternateLocationMapping 方法 (vswriter.h)

AddAlternateLocationMapping 方法为文件集创建备用位置映射。

语法

HRESULT AddAlternateLocationMapping(
  [in] LPCWSTR wszSourcePath,
  [in] LPCWSTR wszSourceFilespec,
  [in] bool    bRecursive,
  [in] LPCWSTR wszDestination
);

参数

[in] wszSourcePath

以 Null 结尾的宽字符串,其中包含包含要映射的文件的目录或目录层次结构的名称。

目录可以是 VSS 计算机上的本地目录,也可以是远程文件服务器上的文件共享目录。

路径可以包含环境变量 (例如 %SystemRoot%) ,但不能包含通配符。

不要求路径以反斜杠 (“”) 结尾。 由应用程序来检索此信息以检查。

[in] wszSourceFilespec

以 Null 结尾的宽字符串,其中包含要映射的文件的文件规范。

文件规范不能包含目录规范 (例如,没有反斜杠) 但可以包含 ? 和 * 通配符。

[in] bRecursive

一个布尔值,指定 wszPath 参数指定的路径是仅标识单个目录,还是指示要以递归方式遍历的目录层次结构。 如果将路径视为要以递归方式遍历的目录层次结构,则应将此参数设置为 true ;否则应设置为 false

有关遍历已装载文件夹的信息,请参阅 使用装载的文件夹和重新分析点

[in] wszDestination

以 Null 结尾的宽字符串,其中包含将重新定位文件的目录的完全限定路径。

目录可以是 VSS 计算机上的本地目录,也可以是远程文件服务器上的文件共享目录。

支持 UNC 路径。

返回值

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

含义
S_OK
0x00000000L
操作成功。
E_INVALIDARG
0x80070057L
其中一个参数值无效。
E_OUTOFMEMORY
0x8007000EL
调用方内存或其他系统资源不足。
VSS_E_INVALID_XML_DOCUMENT
0x80042311L
XML 文档无效。 有关详细信息,请查看事件日志。 有关详细信息,请参阅 VSS 下的事件和错误处理
VSS_E_OBJECT_NOT_FOUND
0x80042308L
在调用此方法之前未调用 IVssCreateWriterMetadata::SetRestoreMethod 方法。
VSS_E_UNEXPECTED
意外错误。 错误代码记录在错误日志文件中。 有关详细信息,请参阅 VSS 下的事件和错误处理

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

注解

Windows 7、Windows Server 2008 R2、Windows Vista、Windows Server 2008、Windows XP 和 Windows Server 2003: 在Windows 8和Windows Server 2012之前,不支持远程文件共享。 编写器仅支持本地资源,这些文件集的绝对路径以有效的本地卷规范开头,不能是映射的网络驱动器。 因此,在解析任何环境变量) 后, (wszPathwszDestination) AddAlternateLocationMapping (的路径输入必须采用此格式。

可以多次调用此方法以添加多个文件的映射。

路径、文件规范和递归标志的组合 (wszPathwszFileSpec、 和 bRecursive 分别) 提供给 AddAlternateLocationMapping 进行映射,必须与使用 IVssCreateWriterMetadata::AddFilesToFileGroupIVssCreateWriterMetadata::AddDatabaseFilesIVssCreateWriterMetadata::AddDatabaseLogFiles 添加到编写器组件之一的文件集相匹配。

只有在调用 IVssCreateWriterMetadata::SetRestoreMethod 之后,才应调用 AddAlternateLocationMapping 方法。

如果以下任一情况为 true,应始终将文件还原到其备用位置映射:

  • VSS_RME_RESTORE_TO_ALTERNATE_LOCATION备份时 (设置还原方法) 。
  • 其还原目标在还原时 () 设置为VSS_RT_ALTERNATE。
在任一情况下,如果未定义有效的备用位置映射,则构成编写器错误。

如果符合以下任一条件,则可以将文件还原到备用位置映射:

  • 还原方法VSS_RME_RESTORE_IF_NOT_THERE并且磁盘上已存在文件的某个版本。
  • 还原方法VSS_RME_RESTORE_IF_CAN_REPLACE并且磁盘上存在文件版本,无法替换。
同样,如果未定义有效的备用位置映射,则构成编写器错误。

备用位置映射仅在还原操作期间使用,不应与仅在备份操作期间使用的备用路径混淆。

有关 VSS 下备份和还原文件位置的详细信息,请参阅 非默认备份和还原位置

要求

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

另请参阅

IVssCreateWriterMetadata