IVssWMFiledesc：：GetAlternateLocation 方法 (vswriter.h)

GetAlternateLocation 方法获取文件集的备用位置。

语法

HRESULT GetAlternateLocation(
  [out] BSTR *pbstrAlternateLocation
);

参数

[out] pbstrAlternateLocation

调用方分配的变量的地址，该变量接收指定备用备份位置的字符串。 此位置的路径可以是本地路径或远程文件共享的 UNC 路径。 如果没有备用位置，则指针为 NULL。

返回值

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

值	含义
S_OK	已成功返回备用位置信息。
S_FALSE	找不到请求的信息。
E_INVALIDARG	其中一个参数值无效。
E_OUTOFMEMORY	调用方内存或其他系统资源不足。
VSS_E_INVALID_XML_DOCUMENT	XML 文档无效。 有关详细信息，请查看事件日志。 有关详细信息，请参阅 VSS 下的事件和错误处理。
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 之前不支持远程文件共享。

调用方必须调用 SysFreeString 以释放 pbstrAlternateLocation 参数保留的内存。

GetAlternateLocation 返回的备用位置的解释因用于检索 IVssWMFiledesc 对象的方法而异。

• IVssExamineWriterMetadata：：GetExcludeFile
• IVssWMComponent：：GetDatabaseFile
• IVssWMComponent：：GetDatabaseLogFile
• IVssWMComponent：：GetFile

GetAlternateLocation 返回的值引用由 IVssExamineWriterMetadata：：GetAlternateLocationMapping 方法返回的备用位置映射。

在备份操作期间，这是备份文件的备用位置。 在还原期间，它是将文件还原到的备用位置。

有关详细信息，请参阅 非默认备份和还原位置。

要求

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

另请参阅

IVssWMFiledesc